Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.16 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.16 KB

The tools

You'll need NOWEB to compile the source to Python. (Or to compile the source to TeX for documentation.)

Once you have that, you clone the repo and recurse through submodules. Either

git clone --recurse-submodules

or

git clone [...]
git submodule --update --init --recursive

Working with the source

The main parts for the documentation is located in /doc. These files are documentation only files. To compile the documentation, go to /doc and run make all.

The package source code is located in /src/ladok3. These files contains both the Python code and the documentation for the code. To compile the Python package, go to /src/ladok3 and run make all.

Alternatively, one can run make all in the root to build both. make install will run pip install -e .. This is useful for development.

Workflow

Please fork the repository, make your changes, commit them and then create a pull request in the original repository.