https://github.com/openmeeg/openmeeg.github.io
OpenMEEG web site
https://github.com/openmeeg/openmeeg.github.io
Last synced: about 1 month ago
JSON representation
OpenMEEG web site
- Host: GitHub
- URL: https://github.com/openmeeg/openmeeg.github.io
- Owner: openmeeg
- License: other
- Created: 2013-11-11T12:40:48.000Z (over 11 years ago)
- Default Branch: source
- Last Pushed: 2022-08-31T12:49:35.000Z (over 2 years ago)
- Last Synced: 2024-03-26T07:15:42.409Z (about 1 year ago)
- Language: CSS
- Homepage: http://openmeeg.github.io
- Size: 8.92 MB
- Stars: 0
- Watchers: 6
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: license.rst
Awesome Lists containing this project
README
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](http://docutils.sourceforge.net/rst.html)
and build using [**Sphinx**](http://www.sphinx-doc.org/) 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](http://www.sphinx-doc.org/en/stable/install.html),
but in short you can install it from [**pip**](https://pypi.python.org/pypi/pip)
(but you can also get from most package managers or conda).
```sh
$ 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:
```sh
$ 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:
```sh
$ 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:
```sh
$ 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](http://github.com/).
Once this is done, fork the [openmeeg.github.io repository](http://github.com/openmeeg/openmeeg.github.io)
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.