Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.08 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.08 KB

Command line python script called "readme" that,

INSTALLATION sudo python setup.py install

you need to use sudo, because after install it copies readme short script to usr/local/bin which allows to run current script from anywhere

DOC when run from any location on the linux filesystem,

generates a new file in same directory called "README_<enclosing_directory>.txt".

Input: The script will take as inputs a series of quote enclosed strings as keywords.

Output The contents of "README_<enclosing_directory>.txt" will be a YAML containing :

location: timestamp: keywords: files: <all file names in this directory & all sub directories, one per row>

config The software should have a config file that lets us specify a folder on the system where symlinks to each generated readme file goes.

Details: a) Written in Python b) All development done in Github (if you get the job, first job is to share w/ me) c) Should be setup for installation via disutils