Skip to content

Latest commit

 

History

History
159 lines (96 loc) · 4.84 KB

README.md

File metadata and controls

159 lines (96 loc) · 4.84 KB

RepoBareBones

Made with <3 by Amazing Cow.

Websites:

Description:

Just create a bunch of standard files on the brand new repos.

It'll create:

  • README.md
  • AUTHORS.txt
  • CHANGELOG.txt
  • COPYING.txt
  • TODO.txt

Nothing fancying... really!

Motivation:

Because we're lazy enough to do not want to copy/write those files everytime that we create a new repository, but yet want them!


As usual, you are **very welcomed** to **share** and **hack** it.

Usage:

repobb [--help | --version] [--n2omatt | --amazingcow] [--force] [project-name]

Options:
  *-h --help     : Show this screen.
  *-v --version  : Show app version and copyright.

  --n2omatt    : Copy the README.md to n2omatt projects.
  --amazingcow : Copy the README.md to Amazing Cow projects. [Default]

  --force : Overwrite previous files.

  project-name : Specify the name of the project. Otherwise repobb will try
                 to get it from the git info.

Notes:
  Options marked with * are exclusive, i.e. the repobb will run that
  and exit after the operation.

  --amazingcow is the default target, with no options are given,
    it will be used to generate the README.md

Examples:

$ repobb --amazingcow # Will generate the files targeting Amazing Cow!
$ repobb --n2omatt    # Will generate the files targeting N2OMatt!

Documentation:

We strive to make our source code fully documented.

Anyway if you didn't understand something let us know sending a mail to
[email protected] with the subject filled with the name of this repo.

Dependencies:

There is no dependency for RepoBareBones.

License:

This software is proudly released under GPLv3.

BUGS:

We strive to make all our code the most bug-free as possible - But we know that few of them can pass without we notice ;).

Please if you find any bug report to [email protected] with the name of this project and/or create an issue here in Github.

TODO:

Check the TODO file for general things.

This projects uses the COWTODO tags.
So install cowtodo and run:

$ cd path/to/the/project
$ cowtodo

That's gonna give you all things to do :D.

Others:

Check our other Free Software repos and take a look at our free software site.