Default meta docs for new projects
Project description
# Project name
<!— These are examples. See https://shields.io for others or to customize this set of shields. You might want to include dependencies, project status and licence info here —>
![GitHub repo size](https://img.shields.io/github/repo-size/alexpdev/dotfiles) ![GitHub contributors](https://img.shields.io/github/contributors/alexpdev/dotfiles) ![GitHub stars](https://img.shields.io/github/stars/alexpdev/dotfiles?style=social) ![GitHub forks](https://img.shields.io/github/forks/alexpdev/dotfiles?style=social) ![Twitter Follow](https://img.shields.io/badge/dotfiles-.files-green)
Project name is a <utility/tool/feature> that allows <insert_target_audience> to do <action/task_it_does>.
Additional line of information text about what the project does. Your introduction should be around 2 or 3 sentences. Don’t go overboard, people won’t read it.
## Prerequisites
Before you begin, ensure you have met the following requirements:
<!— These are just example requirements. Add, duplicate or remove as required —>
You have installed the latest version of <coding_language/dependency/requirement>
You have a <Windows/Linux/Mac> machine. State which OS is supported/which is not.
You have read <guide/link/documentation_related_to_project>.
## Installing <project_name>
To install <project_name>, follow these steps:
Linux and macOS:
`bash echo <install_command> `
Windows:
`bash echo <install_command> `
## Using <project_name>
To use <project_name>, follow these steps:
`bash echo <usage_example> `
Add run commands and examples you think users will find useful. Provide an options reference for bonus points!
## Contributing to <project_name> <!— If your README is long or you have some specific process or steps you want contributors to follow, consider creating a separate CONTRIBUTING.md file—> To contribute to <project_name>, follow these steps:
Fork this repository.
Create a branch: git checkout -b <branch_name>.
Make your changes and commit them: git commit -m ‘<commit_message>’
Push to the original branch: git push origin <project_name>/<location>
Create the pull request.
Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## Contributors
Thanks to the following people who have contributed to this project:
[@me](https://github.com/alexpdev) 🐛
You might want to consider using something like the [All Contributors](https://github.com/all-contributors/all-contributors) specification and its [emoji key](https://allcontributors.org/docs/en/emoji-key).
## Contact
If you want to contact me you can reach me at <your_email@address.com>.
## License
<!— If you’re not sure which open license to use see https://choosealicense.com/—>
This project uses the following license: [<license_name>](<link>).
Project details
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 Distributions
File details
Details for the file ap-dotfiles-0.1.0.tar.gz
.
File metadata
- Download URL: ap-dotfiles-0.1.0.tar.gz
- Upload date:
- Size: 16.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.62.3 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3087246168d8768b1211e4e332cfcf4c0e179fe35a4dd2154ac5072c6a3d623 |
|
MD5 | 20093b3e264e75c83066bd62f9444630 |
|
BLAKE2b-256 | 74a8338114300dd3921f8368cb6a5ee924ee73fe24f591037a492aa192eab13f |
File details
Details for the file ap_dotfiles-0.1.0-py3.10.egg
.
File metadata
- Download URL: ap_dotfiles-0.1.0-py3.10.egg
- Upload date:
- Size: 18.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.62.3 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f49d554abddc5546a627a8a5942f755cabdaa3d036bae632f32027376b93ce8c |
|
MD5 | 1d6534e5a026200304947b28f43cd7c3 |
|
BLAKE2b-256 | 606423ac09b9d56a8c98184f097f3d4a6ca45e169e829b119e2ced05a06f83d9 |
File details
Details for the file ap_dotfiles-0.1.0-py3-none-any.whl
.
File metadata
- Download URL: ap_dotfiles-0.1.0-py3-none-any.whl
- Upload date:
- Size: 19.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.62.3 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e258d0412ab475c03c5bba2c2571803063c7b0a00ec9def64f08b37b9da64b3 |
|
MD5 | fcee60bdd6ff2a6e0b2df57769141b51 |
|
BLAKE2b-256 | ca07e68c7cb3111084e408ea0d62e95577451393874dfb052c0d2831706ce531 |