Getting Started

There are a lot of docs on this Wiki, but getting started is easy. Just follow these steps, and then consult the rest of the docs as needed.

1. Clone the Qi repo

$ git clone git@github.com:drym-org/qi.git

2. Install it for development

$ make install

If you already had a version of Qi installed this would complain, and in that case, remove the original version and try again. More detailed instructions are at Installing Qi for Development.

3. Try Building Locally, Running Tests, Viewing Docs

# compile
$ make build

# run tests
$ make test

# build docs
$ make build-docs

# view docs locally in a browser
$ make docs

And that's it! You're well on your way.

Next Steps

By way of introducing the rest of these developer docs:

• Code contains information about the codebase, directory structure, module contents, development workflows, guidelines on making contributions, etc.
• Infrastructure contains information about CI, and administrative info like making new releases.