improve the README file structure

This commit is contained in:
2019-05-18 23:35:52 +02:00
parent 2e649cee9b
commit 12956dc622

View File

@@ -1,20 +1,19 @@
* Install * Install
Install in "development mode" so any change of the program is effective. Install in "development mode" so any change of the program is effective.
Note: For system wide (global) installation log in as root or use sudo for example. Note: For system wide (global) installation log in as root or use sudo for
For local (user) installation the local path must be in the PYTHONPATH environment variable. example. For local (user) installation the local path must be in the
Typically $HOME/.local/lib/pythonX.Y/site-packages =PYTHONPATH= environment variable.
Typically =$HOME/.local/lib/pythonX.Y/site-packages=
' pip install -e .
or
' pip install --user -e .
or
' python -m pip install -e .
or
' easy_install --prefix=$HOME/.local -e .
or
' pip install --install-option="--prefix-$HOME/.local" -e .
Use either:
#+BEGIN_SCR shell
pip install -e .
pip install --user -e .
python -m pip install -e .
easy_install --prefix=$HOME/.local -e .
pip install --install-option="--prefix-$HOME/.local" -e .
#+END_SCR
* Uninstall * Uninstall
pip uninstall materials pip uninstall materials