change to Markdown syntax

This commit is contained in:
2020-10-20 16:38:49 +02:00
parent 4c2aaf6b96
commit 88d3d2d338
2 changed files with 17 additions and 20 deletions

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# Install
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.
For local (user) installation the local path must be in the `PYTHONPATH` environment variable.
Typically `$HOME/.local/lib/pythonX.Y/site-packages`
Use either:
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 .
# Uninstall
pip uninstall mechanics

View File

@@ -1,20 +0,0 @@
* Install
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.
For local (user) installation the local path must be in the 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 .
* Uninstall
pip uninstall mechanics