Skip to content

Commit

Permalink
Update and rename README.md to README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
saivan4ick authored Nov 7, 2022
1 parent 812384d commit 8b509c7
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

25 changes: 25 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
stern is a free and open-source library by developer saivan

Installation
------------
::

pip install stern
Help
------------
If you are just getting started with stern, you should be able to get started fairly quickly.

The online documentation stays up to date with the development version of stern on github. This may be a bit newer than the version of stern you are using. To upgrade to the latest full release, run pip install stern --upgrade in your terminal.

Building From Source
--------------------
If you want to use features that are currently in development, or you want to contribute to stern, you will need to build stern locally from its source code, rather than pip installing it.

Installing from source is fairly automated. The most work will involve compiling and installing all the stern dependencies. Once that is done, run the setup.py script which will attempt to auto-configure, build, and install stern.

This is how you help the stern module learn and achieve new technologies and features of the Python programming language.

License
-------
This library is distributed under GNU LGPL version 3.0, which can be found in the file ``LICENSE``.
We reserve the right to place future versions of this library under a different license. This basically means you can use stern in any project you want, but if you make any changes or additions to stern itself, those must be released with a compatible license (preferably submitted back to the stern project).

0 comments on commit 8b509c7

Please sign in to comment.