aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2018-03-31 15:41:28 +0200
committerCédric Bonhomme <cedric@cedricbonhomme.org>2018-03-31 15:41:28 +0200
commit93df8f6c046b45401da56c15ed2cb43a17f5c371 (patch)
treec9b3ac08f491529508a4a7de0ef014925a7645b7
parentMerge pull request #37 from EdwardBetts/spelling (diff)
downloadnewspipe-93df8f6c046b45401da56c15ed2cb43a17f5c371.tar.gz
newspipe-93df8f6c046b45401da56c15ed2cb43a17f5c371.tar.bz2
newspipe-93df8f6c046b45401da56c15ed2cb43a17f5c371.zip
Updated README.
-rw-r--r--README.rst26
1 files 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 <https://github.com/newspipe/newspipe>`_ is a web-based news
aggregator and reader.
@@ -26,7 +28,8 @@ The core technologies are `Flask <http://flask.pocoo.org>`_,
`SQLAlchemy <http://www.sqlalchemy.org>`_
and `React <https://facebook.github.io/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
-------------
@@ -52,22 +56,36 @@ 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 <https://github.com/newspipe/newspipe>`_ is under the
`GNU Affero General Public License version 3 <https://www.gnu.org/licenses/agpl-3.0.html>`_.
+
Contact
-------
bgstack15