From 93df8f6c046b45401da56c15ed2cb43a17f5c371 Mon Sep 17 00:00:00 2001 From: Cédric Bonhomme Date: Sat, 31 Mar 2018 15:41:28 +0200 Subject: Updated README. --- README.rst | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 3522b7a1..ceed74d2 100644 --- a/README.rst +++ b/README.rst @@ -2,9 +2,11 @@ 🗞 Newspipe 🗞 ============= + Presentation ------------ + `Newspipe `_ is a web-based news aggregator and reader. @@ -26,7 +28,8 @@ The core technologies are `Flask `_, `SQLAlchemy `_ and `React `_. -Python >= 3.5 is required. +Python >= 3.6 is required. + Documentation ------------- @@ -43,6 +46,7 @@ Test Newspipe on Heroku: It is important to specify an application name and the URL of your instance (*PLATFORM_URL*) through the Heroku form. + Contributions ------------- @@ -50,24 +54,38 @@ Contributions are welcome. If you want to contribute to Newspipe I highly recommend you to install it in a Python virtual environment. For example: +.. code-block:: bash + + sudo apt-get install postgresql npm + +It seems that today a proof of good taste is to install first +[pyenv](https://github.com/pyenv/pyenv), +then [pipsi](https://github.com/mitsuhiko/pipsi), and finally +[pew](https://github.com/berdario/pew) and +[pipenv](https://github.com/pypa/pipenv) with pipsi. + + .. code-block:: bash git clone https://github.com/newspipe/newspipe.git cd newspipe/ - pew install 3.6.1 --type CPython - pew new --python=$(pew locate_python 3.6.1) -a . -r requirements.txt newspipe-dev + pipenv install + ✨🍰✨ + npm install cp src/conf/conf.cfg-sample src/conf/conf.cfg + pipenv shell python src/manager.py db_create - npm install python src/runserver.py * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit) + License ------- `Newspipe `_ is under the `GNU Affero General Public License version 3 `_. + Contact ------- -- cgit