aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2017-06-28 08:15:42 +0200
committerCédric Bonhomme <cedric@cedricbonhomme.org>2017-06-28 08:15:42 +0200
commitd3c24d794344d3c0953a58cbbb3b4889464d5508 (patch)
treeba2d102202a6125ce7cc468268f5843ee2da7f6e
parentGet the 'from email' address via the configuration module. (diff)
downloadnewspipe-d3c24d794344d3c0953a58cbbb3b4889464d5508.tar.gz
newspipe-d3c24d794344d3c0953a58cbbb3b4889464d5508.tar.bz2
newspipe-d3c24d794344d3c0953a58cbbb3b4889464d5508.zip
Just testing pew in order to ease contributions.
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 36748731..3522b7a1 100644
--- a/README.rst
+++ b/README.rst
@@ -43,6 +43,25 @@ 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
+-------------
+
+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
+
+ 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
+ cp src/conf/conf.cfg-sample src/conf/conf.cfg
+ 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
-------
bgstack15