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
-
Download the
Readme Page
ZIP. -
Unpack and put it inside your local repository.
-
Change the current working directory to
cd readme-page
. -
Run
make readme-page
to create your repository GitHub Page.Run
make help
for more information. -
Checkout the repository page at
https://<your_github_username>.github.io/<repository_name>
Contributing
See CONTRIBUTING.
License
The MIT License.
-
Copyright (c) 2016 Fernando Felix do Nascimento Junior.
-
This project uses mkdocs, a Python tool to create project documentation with markdown.