From 3f2aa1d3ddc4839fffaf651ca046e7f8ffd53889 Mon Sep 17 00:00:00 2001 From: pei Date: Fri, 22 Dec 2023 23:58:25 +0000 Subject: [PATCH] Add readme --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1db99da --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Project Title + +Simple overview of use/purpose. + +## Description + +An in-depth paragraph about your project and overview of use. + +## Getting Started + +### Dependencies + +* Describe any prerequisites, libraries, OS version, etc., needed before installing program. +* ex. Windows 10 + +### Installing + +* How/where to download your program +* Any modifications needed to be made to files/folders + +### Executing program + +* How to run the program +* Step-by-step bullets +``` +code blocks for commands +``` + +## Help + +Any advise for common problems or issues. +``` +command to run if program contains helper info +``` + +## Authors + +Contributors names and contact info + +ex. Dominique Pizzie +ex. [@DomPizzie](https://twitter.com/dompizzie) + +## Version History + +* 0.2 + * Various bug fixes and optimizations + * See [commit change]() or See [release history]() +* 0.1 + * Initial Release + +## License + +This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details + +## Acknowledgments + +Inspiration, code snippets, etc. +* [awesome-readme](https://github.com/matiassingers/awesome-readme) +* [PurpleBooth](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2) +* [dbader](https://github.com/dbader/readme-template) +* [zenorocha](https://gist.github.com/zenorocha/4526327) +* [fvcproductions](https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46) \ No newline at end of file