guide.rst

Getting started

1. Step one: install Universum <install>. Use {python} -m universum --help to make sure the installation was successful, and also to get the list of available parameters <args>.
2. Step two: initialize Universum <additional_commands#init> by creating a default configuration file <configuring> and modifying it according to the project needs.
3. Step three: use {python} -m universum run to check the provided configuration locally <additional_commands#run>.
4. Step four: submit a working configuration file to a VCS and pass required parameters <args> to Universum to work with it.
5. Configure CI, using Universum, on a CI server. See the following guides for TeamCity <teamcity> or GitHub <github_handler#jenkins>.