56 lines
633 B
Markdown
56 lines
633 B
Markdown
# Optifik
|
|
|
|
TODO: write a paragraph here...
|
|
|
|
|
|
This library replaces oospectro.
|
|
|
|
|
|
## Installation
|
|
|
|
The use of pip must be limited to virtualenv
|
|
|
|
|
|
* From PyPI
|
|
```
|
|
pip install optifik
|
|
```
|
|
|
|
* From tarball
|
|
```
|
|
pip install /path/to/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
|
|
```
|
|
|
|
## Licence
|
|
|
|
The source code is released under the GNU General Public License v3.0.
|
|
See LICENSE for details.
|