eris/make-readme.py
Andrew Hamilton 0080db66d4 Used test-distributions to fix the installation.
- Correctly using our urwid.
- LS_COLORS needed to be in the package.
- Didn't need to use pip3.
2017-06-28 09:07:40 +01:00

43 lines
962 B
Python
Executable file

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright (C) 2017 Andrew Hamilton. All rights reserved.
# Licensed under the Artistic License 2.0.
import vigil.tools as tools
def tool_markup(tool):
url = tools.url_of_tool(tool)
return (tool.__name__ if url is None else
"[%s](%s)" % (tool.__name__, url))
print("""\
# Vigil Code Monitor
### Summary
Vigil maintains an up-to-date set of reports for every file in a codebase.
### Installation
(Tested in Ubuntu 17.04)
# git clone https://github.com/ahamilton/vigil
# cd vigil
# ./install-dependencies
# sudo python3 setup.py install (pip3 can be used here)
then to run:
# vigil <directory_path>
### Tools
Extensions | Tools
---------- | -----""")
for extensions, tools_ in tools.TOOLS_FOR_EXTENSIONS:
print("%s | %s" % (" ".join("." + extension for extension in extensions),
"".join(tool_markup(tool) for tool in tools_)))