doc/README.md

Osmose documentation

User documentation for Osmose

Follow this steps to automatically build and open the osmose documentation user guide

  1. Clone this repository in a working directory.
  2. Install Anaconda using this link (for Windows, Linux, macOS): https://www.anaconda.com/download/
  3. Open "Anaconda" and install sphinx using: pip install sphinx
  4. Go to the directory where this repository was cloned. Use the command 'pushd' plus the working directory.
  5. Generate the documentation with: make html
  6. Now the documentation was created and to opened it go to: cd _build\html
  7. Open the file: index.html


roliveros-ramos/osmose documentation built on Feb. 19, 2023, 8:19 a.m.