It’s so great that you want to contribute! The documentation here includes information about using and developing qme, and they are hosted on Github, meaning that you can easily contribute via a pull request.

Getting Started

Installing Dependencies

Initially (on OS X), you will need to setup Brew which is a package manager for OS X and Git. To install Brew and Git, run the following commands:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install git

If you are on Debian/Ubuntu, then you can easily install git with apt-get

apt-get update && apt-get install -y git

Fork the repo

To contribute to the web based documentation, you should obtain a GitHub account and fork the qme Documentation repository by clicking the fork button on the top right of the page. Once forked, you will want to clone the fork of the repo to your computer. Let’s say my GitHub username is meatball:

git clone https://github.com/meatball/qme
cd qme/

Install a local Jekyll server

This step is required if you want to render your work locally before committing the changes. This is highly recommended to ensure that your changes will render properly and will be accepted.

brew install ruby
gem install jekyll
gem install bundler
bundle install

The documentation is located in the “docs” subfolder, so after cloning the repository, you can change the directory to there and then run the jekyll serve. Specifically, you can see the site locally by running the server with jekyll:

cd docs
bundle exec jekyll serve

This will make the site viewable at http://localhost:4000/qme/.