Skip to content

This is a "better" readme generator than my previous JavaScript one. It includes a GUI and allows for you to specify the location you wish to save the readme.

License

Notifications You must be signed in to change notification settings

justinyates887/python-readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EZ-README

GitHub Repo

Download!

license size forks lines stars pulls

Table of Contents

Description

An easy readme generator coded in Python with a User Interface. No more typing up those pesky README's! This program will give you a generic template that you can add on to within the program, and then save to the location of your project.

Installation

Just run the .exe in build and you're good to go! You can download the .exe folder here

All source is within the /run folder.

Usage

For any dev tired of writing their READMEs

Contributors

Justin Yates

Tests

Manual testing done as of now. I don't see any need for formal tests on a small project like this.

License

MIT License

Copyright (c) 2021 Justin Yates

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

This is a "better" readme generator than my previous JavaScript one. It includes a GUI and allows for you to specify the location you wish to save the readme.

Topics

Resources

License

Stars

Watchers

Forks

Languages