Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 2.58 KB

README.md

File metadata and controls

75 lines (53 loc) · 2.58 KB
Raw

Openmeeg website

This repository contains the source code of the openmeeg website which contains all the documentation to get started in using openmeeg.

The documentation is written in reStructuredText and build using Sphinx to render as a website.

Requirerments

In order to build our documentation, the following packages need to be available:

  • make
  • sphinx

Refer to Sphinx doc in how to install it, but in short you can install it from pip (but you can also get from most package managers or conda).

$ pip install sphinx

Most of the systems already come with make build utils, but if yours doesn't use your favorite package manager to install it. For Debian based systems (such as Ubuntu) do:

$ sudo apt-get install build-essential

Optional dependencies

If you would like to build the documentation in latex rather than html the following packages are needed:

  • pdflatex
  • texlive-anyfontsize

Again, use your favorite package manager to install the latex. Make sure that textlive-anyfontsize package is there. For Debian based systems (such as Ubuntu) do:

$ sudo apt-get install texlive-full

How to build the openmeeg documentation

In order to build the website just in build the html target from the root of the project as follows:

$ git clone -b source https://github.com/openmeeg/openmeeg.github.io
$ cd openmeeg.github.io
$ make html

This should generate a folder called ./build/html/ containing the index.html. Open this file with any browser to see your local version of openmeeg website.

Otherwise, to build the documentation in latex use make latex.

How to contribute

To contribute to openmeeg.github.io, first create an account on github. Once this is done, fork the openmeeg.github.io repository to have your own repository, clone it using git clone on the computers where you want to work. Make your changes in your fork, push them to your github account, test them on several computers, and when you are happy with them, send a pull request to the main repository.

All contributions are welcome. If you want to contribute to openmeeg don't hesitate we are a friendly community come swing by.