Readme Page

A script to create a readme GitHub Page for your project. See an example.

This project uses BeautifulSoup, mkdocs and six.

Installation & Usage

1. Create a virtual environment into your project and activate it.

   virtualenv env && source env/bin/activate

2. pip install readme-page to install the script.

3. readme-page to create your repository GitHub Page.

4. Checkout the repository page at http://<your_github_username>.github.io/<repository_name>

Contributing

See CONTRIBUTING.

License

The MIT License.

Copyright (c) 2016 Fernando Felix do Nascimento Junior.