Verified Commit f0f2d215 authored by JoKeyser's avatar JoKeyser Committed by Sunil Mohan Adapa

doc: update HACKING, CONTRIBUTING and INSTALL information

 - use markdown more explicitly
 - update information on i18n and translation
 - move or delete redundant info from HACKING into CONTRIBUTING
Signed-off-by: JoKeyser's avatarJohannes Keyser <johanneskeyser@posteo.de>
Reviewed-by: Sunil Mohan Adapa's avatarSunil Mohan Adapa <sunil@medhas.org>
parent 1779ac89
# Contributing
Here are some contributing guidelines for authors and reviewers of code changes.
The goal is a readable log of code changes, to enhance transparency of their
purpose and simplify debugging. Consider these guidelines as best practices, not
......@@ -19,8 +20,11 @@ Naming conventions:
# For authors of patches
* If you would like to contribute, but are unsure what to do, just ask. There
are usually also issues tagged as "beginners", which might be a good starting
point.
are usually also issues tagged as 'beginner', which might be a good starting
point to work on and have a known solution. Also, other developers are ready
to guide you on the implementation for such tasks.
Feel free to pickup a task from the issue by announcing it on the issue or by
creating a new issue for whatever task you are going to work on.
* To get your changes included, you must open a pull request (PR), to get them
reviewed. Briefly, fork the repository to your account, and edit, commit and
push there. Then you can create a PR to the main repository.
......
This diff is collapsed.
......@@ -2,75 +2,89 @@
1. Install the dependencies:
On a Debian based system, run:
$ sudo apt-get install \
augeas-tools \
dblatex \
docbook-utils \
gettext \
gir1.2-glib-2.0 \
gir1.2-nm-1.0 \
ldapscripts \
libjs-bootstrap \
libjs-jquery \
libjs-modernizr \
make \
network-manager \
ppp \
pppoe \
python3 \
python3-apt \
python3-augeas \
python3-bootstrapform \
python3-cherrypy3 \
python3-configobj \
python3-coverage \
python3-django \
python3-django-axes \
python3-django-captcha \
python3-django-stronghold \
python3-gi \
python3-psutil \
python3-requests \
python3-ruamel.yaml \
python3-setuptools \
xmlto
On a Debian based system, run:
```
$ sudo apt-get install \
augeas-tools \
dblatex \
docbook-utils \
gettext \
gir1.2-glib-2.0 \
gir1.2-nm-1.0 \
ldapscripts \
libjs-bootstrap \
libjs-jquery \
libjs-modernizr \
make \
network-manager \
ppp \
pppoe \
python3 \
python3-apt \
python3-augeas \
python3-bootstrapform \
python3-cherrypy3 \
python3-configobj \
python3-coverage \
python3-django \
python3-django-axes \
python3-django-captcha \
python3-django-stronghold \
python3-gi \
python3-psutil \
python3-requests \
python3-ruamel.yaml \
python3-setuptools \
xmlto
```
2. Install Plinth:
Unzip the source into a directory. Change to the directory containing the
program and run:
Unzip the source into a directory. Change to the directory containing the
program and run:
$ sudo python3 setup.py install
$ sudo apt install -y $(plinth --list-dependencies)
```
$ sudo python3 setup.py install
$ sudo apt install -y $(plinth --list-dependencies)
```
3. Run Plinth:
$ sudo plinth
```
$ sudo plinth
```
4. Access Plinth UI:
Plinth UI should be accessible at http://localhost:8000/plinth
Plinth UI should be accessible at http://localhost:8000/plinth
# Note on Django version:
Django 1.11 is required to run Plinth. You can check the version by running:
$ django-admin --version
```
$ django-admin --version
```
If apt-get provided django<1.11, then follow the steps below:
If apt-get provided django < 1.11, then follow the steps below:
1. Uninstall older django versions:
$ sudo apt-get remove python3-django python3-django-stronghold \
python3-bootstrap
```
$ sudo apt-get remove python3-django python3-django-stronghold \
python3-bootstrap
```
2. Install Python3 pip:
$ sudo apt-get install python3-pip
```
$ sudo apt-get install python3-pip
```
3. Install django1.11 through pip:
$ sudo pip3 install django django-bootstrap-form django-stronghold \
django-axes django-simple-captcha --upgrade
```
$ sudo pip3 install django django-bootstrap-form django-stronghold \
django-axes django-simple-captcha --upgrade
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment