Skip to main content

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

  1. Run pip install readme-page to install the script.

  2. Run readme-page to create your repository GitHub Page.

  3. 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

[![CC0](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/)

The MIT License.

Copyright (c) 2016 [Fernando Felix do Nascimento Junior](https://github.com/fernandojunior/).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readme-page-1.0.0.tar.gz (3.9 kB view details)

Uploaded Source

Built Distribution

readme_page-1.0.0-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file readme-page-1.0.0.tar.gz.

File metadata

  • Download URL: readme-page-1.0.0.tar.gz
  • Upload date:
  • Size: 3.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for readme-page-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0b5c690503510e7599901052dac2e007307c4a2fc6ce1bae7c3075b13b70bc8c
MD5 e9ae1d037c2f607bc5bae257b4504acf
BLAKE2b-256 30f7d760272e74be1d6c4a6399721bfa7c5b03f011be8f7078535a5d2f10f5e5

See more details on using hashes here.

File details

Details for the file readme_page-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for readme_page-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a881532fc1b94f479eec6b62f1b8b78fa710bad05cfe5d4fb6f6596a2d1623f5
MD5 c94a1670e8ca85d3949647ba9db095d1
BLAKE2b-256 bc89017adb3c833b3ca74a6555ba4a3f9fd95384e021b3c8c56eb94d4960349e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page