Readme Page

A script to create a simple readme GitHub Page for your project.

The page is only based on the README.md of the master branch of your project repository.

Usage

  1. Download the Readme Page ZIP.

  2. Unpack and put it inside your local repository.

  3. Change the current working directory to cd readme-page.

  4. Run make readme-page to create your repository GitHub Page.

    Run make help for more information.

  5. Checkout the repository page at https://<your_github_username>.github.io/<repository_name>

Contributing

See CONTRIBUTING.

License

CC0

The MIT License.

-

Copyright (c) 2016 Fernando Felix do Nascimento Junior.

-

This project uses mkdocs, a Python tool to create project documentation with markdown.