Managing redundant information within software

We here assume that you are using the Git Version Control System (VCS) to develop a repository denoted <reponame>.

$ mkdir <reponame>
$ cd <reponame>
$ git init
$ ls -a
. .. .git

Using a configuration file, MngIt aims at dispatching redundant information in various files that can be considered as mandatory in repositories. The configuration file named .mngit.yml is created at the root of <reponame> using the mngit config command.

$ mngit config
$ ls -a
. .. .git .mngit.yml

These informations are then dispatched in the repository using the mngit update command. This configuration file is formatted according to the YAML human friendly data serialization standard. This configuration file is incrementally filled using commands that are presented in the remainder of this documentation.

• The software field
• The about field
• The version field
• The authors field
• The license field
• The restructuredtext field

Note

For now, we only consider the Git VCS but features could be added to in order to accept the Subversion VCS.

Note

This documentation only illustrate command purposes. For more detailed information use the -h option (e.g. mngit -h, mngit config -h...)