Skip to content

Commit

Permalink
chore: update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Deuchnord committed Dec 16, 2023
1 parent e435b19 commit 7aff41b
Showing 1 changed file with 6 additions and 14 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,21 @@

[![Coverage Status](https://coveralls.io/repos/github/Kosmorro/lib/badge.svg?branch=main)](https://coveralls.io/github/Kosmorro/lib?branch=main) [![Version on PyPI](https://img.shields.io/pypi/v/kosmorrolib)](https://pypi.org/project/kosmorrolib) [![IRC: #kosmorro on Libera.Chat](https://img.shields.io/badge/Libera.Chat-%23kosmorro-blueviolet)](https://web.libera.chat/?nick=Astronaut?#kosmorro)

[![Stand with Ukraine](https://github.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
Kosmorrolib is the Python library internally used in Kosmorro. It provides easy-to-use functions for your calculation needs.

## Installation

### Requirements

Kosmorrolib requires the following software to work:
The library is built on [Skyfield](https://rhodesmill.org/skyfield/), an excellent library designed to compute positions for any objects in the Solar system.

- Python ≥ 3.8.0

And that's all!

### Production environment
## Installation

Kosmorrolib is available [on PyPI](https://pypi.org/project/kosmorrolib/). To use it, invoke `pip install kosmorrolib`.
Take a look at [the official documentation](https://kosmorro.space/lib) for the information about how to install this library.

### Development environment

To contribute to Kosmorrolib, you will need [Poetry](https://python-poetry.org), a software to manage the project from development to publishing.

Clone this repository and run `poetry install` to install the dependencies.
And that's all, your development environment is ready for the fight! 👏
And that's all, your development environment is ready!

## Documentation

All the documentation can be found [on the website](https://kosmorro.space/lib/doc).
You can find all the documentation of the library [on the website](https://kosmorro.space/lib/doc).

0 comments on commit 7aff41b

Please sign in to comment.