A script to create a readme GitHub Page for your project.
Project description
# Readme Page
A script to create a readme [GitHub Page](https://help.github.com/articles/creating-project-pages-manually) for your project. See an [example](http://fernandojunior.github.io/readme-page).
This project uses [BeautifulSoup](http://www.crummy.com/software/BeautifulSoup/), [mkdocs](http://mkdocs.github.io/mkdocs-bootstrap/) and [six](https://pythonhosted.org/six/).
## Installation & Usage
Run pip install readme-page to install the script.
Run readme-page to create your repository GitHub Page.
Checkout the repository page at http://<your_github_username>.github.io/<repository_name>
## Contributing
See [CONTRIBUTING](https://github.com/fernandojunior/readme-page/CONTRIBUTING.md).
## License
The MIT License.
Copyright (c) 2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for readme_page-1.0.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a881532fc1b94f479eec6b62f1b8b78fa710bad05cfe5d4fb6f6596a2d1623f5 |
|
| MD5 | c94a1670e8ca85d3949647ba9db095d1 |
|
| BLAKE2b-256 | bc89017adb3c833b3ca74a6555ba4a3f9fd95384e021b3c8c56eb94d4960349e |
](https://creativecommons.org/licenses/by-nc-sa/4.0/){kind=link}