eris/make-readme.py

41 lines
791 B
Python
Raw Normal View History

2016-11-19 13:50:07 +01:00
#!/usr/bin/env python3
import tools
BODY = """\
# Vigil Code Monitor
### Summary
Vigil shows a list of status reports for a given codebase, and keeps them
up to date as the codebase changes.
### Installation
To run vigil: (Tested in Ubuntu 16.10 in gnome-terminal and stterm)
# git clone https://github.com/ahamilton/vigil
# cd vigil
# ./install-dependencies
# ./vigil <directory_path>
and to test its working properly:
# ./test-all
To run on an older ubuntu you can checkout an older version of vigil.
e.g. After cloning do:
# git checkout ubuntu-15.10
### Tools"""
print(BODY)
for extensions, tools_ in tools.TOOLS_FOR_EXTENSIONS:
print()
print("#### " + " ".join(extensions))
print(" " + " ".join(tool.__name__ for tool in tools_))