doc and install
This commit is contained in:
parent
74cea0083d
commit
42dcda2aaf
4 changed files with 93 additions and 3 deletions
47
README.md
47
README.md
|
@ -0,0 +1,47 @@
|
|||
Optifik version 0.1.0
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
The use of pip must be limited to virtualenv
|
||||
|
||||
|
||||
* From PyPI
|
||||
```
|
||||
pip install optifik
|
||||
```
|
||||
|
||||
* From tarball
|
||||
```
|
||||
pip install /chemin/vers/optifik-0.1.0.tar.gz
|
||||
```
|
||||
|
||||
* From the source code
|
||||
```
|
||||
pip install .
|
||||
```
|
||||
|
||||
|
||||
# For contributors
|
||||
|
||||
* Install an editable version
|
||||
```
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
* Install dev tools
|
||||
```
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
* Install doc tools
|
||||
```
|
||||
pip install -e ".[docs]"
|
||||
```
|
||||
|
||||
* Build the doc
|
||||
```
|
||||
cd docs
|
||||
make html
|
||||
```
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue