Commit fa307c4e authored by nfontrod's avatar nfontrod
Browse files

README.md: update

parent 6e9b1c5e
Pipeline #187 passed with stages
in 1 minute and 1 second
......@@ -19,6 +19,16 @@ This project requires `python>=3.8` to work correctly and the following modules
* seaborn>=0.10.1
* matplotlib>=3.1.2
## Build the Sphinx documentation
The documentation was build using `Sphinx`.
To build the documentation (which contains this document and the Api of the program), go in the doc folder and enter:
```console
$ make html
```
## Usage
### `gc_content` module
......@@ -105,4 +115,4 @@ The figure to give to the `--norm` parameter must be defined like this:
* The column condition must contain the same conditions defined in the `condition` column of the design file.
* The column replicate must contain the same replicates names in the `replicate` column of the design file.
* The column coef contain a value used to normalise the coverage
\ No newline at end of file
* The column coef contain a value used to normalise the coverage
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