Skip to content

Commit

Permalink
Update readme with logo for release (#126)
Browse files Browse the repository at this point in the history
* Update readme with logo

* Remove data readme

Surperseeded by the parameters page
in the documentation
  • Loading branch information
aboucaud authored May 6, 2022
1 parent 9173e42 commit 6285bf4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 160 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
[**Main documentation**](https://aboucaud.github.io/galcheat/) | [**Getting started**](#getting-started) | [**CLI**](#cli) | [**API**](#api) | [**Contributing**](#contributing) | [**License**](#license)

<br>
<img src="docs/images/galcheat_logo.png" alt="galcheat" height=200px>
</p>

[![Python package][gh-workflow-badge]][gh-workflow]
[![License][license-badge]](LICENSE)
![Python supported versions][pyversion-badge]
Expand All @@ -12,16 +18,11 @@
[pypi-badge]: https://badge.fury.io/py/galcheat.svg
[pypi]: https://pypi.org/project/galcheat/

Galaxy Surveys cheatsheet
=========================

Tiny package containing useful parameters from main galaxy surveys (**with units**).

The goal of this project is to provide a Python library with minimal dependencies that centralises galaxy survey properties with adequate reference. Such information tends to be scattered in many places or is often copy/pasted without all of the relevant information like units or sources.

The current parameters and the corresponding units are specified in the [data README](galcheat/data/README.md)

[**Getting started**](#getting-started) | [**CLI**](#cli) | [**API**](#api) | [**Contributing**](#contributing) | [**License**](#license)
The current parameters and the corresponding units are specified in the [documentation](https://aboucaud.github.io/galcheat/parameters.html)

Getting started
---------------
Expand All @@ -44,7 +45,7 @@ galcheat
- **`--refs`**: print the source for each parameter
- **`-h, --help`**: get help

### Exemples
### Examples
```sh
galcheat -s LSST # LSST info
galcheat --refs # all surveys info with refs
Expand Down
Binary file added docs/images/galcheat_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
153 changes: 0 additions & 153 deletions galcheat/data/README.md

This file was deleted.

0 comments on commit 6285bf4

Please sign in to comment.