Website for the Magnum C++11/C++14 graphics engine
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
artwork
content
doxygen
m.css @ 4d2a7cd
.gitignore
.gitmodules
Makefile
README.rst
develop_server.sh
pelicanconf.py
publishconf.py

README.rst

Magnum website

Content for http://magnum.graphics/.

Setting up a local copy

In order to set up a local copy (for example for writing a guest post), you need Python 3 with Pelican, Pyphen and Pillow packages installed and optionally some LaTeX distribution for math rendering.

On ArchLinux it's the following packages:

sudo pacman -S texlive-most pelican python-pillow python-matplotlib
cower -d python-pyphen # Build the python-pyphen package from AUR

On Ubuntu you need these:

sudo apt install texlive-base texlive-latex-extra texlive-fonts-extra python3-matplotlib graphviz
pip3 install pelican Pyphen Pillow

On Windows and macOS pick some LaTeX distribution and make it available in the PATH. Python packages can be installed via pip3 as well:

pip3 install pelican Pyphen Pillow matplotlib

Note: Setting up LaTeX might be problematic and so the website doesn't strictly require it to make life easier for you --- if LaTeX is not found, it will render math formulas as unformatted code instead.

Next, make sure to clone the repository (or your fork of the repository) including submodules so m.css is properly included (use :sh:`git clone --recursive`, for example).

That's it. Now you can build the website and start a webserver on http://localhost:8000 with the following command. The website is automatically rebuilt on changes in the input files.

cd magnum-website
make devserver

Note: If you are on Windows and you don't have Git symlinks enabled, you either need to reinstall Git with symlinks enabled (there's a checkbox for that in the installation wizard) or copy m.css/css/*.css to output/inc/*, otherwise the built website will lack all styling. Sorry for the inconvenience.

If you run into problems, please open an issue. The m.css documentation might also help. Thank you.

Pelican workarounds and publishing notes