Skip to content

utility-code/code_to_readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

Contents

  1. THE README FOR THIS PROGRAM IS ALSO GENERATED BY THE CODE ITSELF.

  2. ADDS ARGUMENTS

  3. FIND THE SIDE COMMENTS AND CREATE CONTENTS LIST

  4. FORMAT THE FILE AND SAVE

  5. MAIN FUNCTION

Docstrings

This program converts all the comments in your code to a README.md file and saves a lot of your time provided you write comments in your code. It is obvious how easy it is to actually generate the README.md file and save your time.Using the argparse module to get the file path. Note that to run the file

python main.py -p <path to file>

For now this program only supports python.

Side comments

  • Initial file

  • Output file

GENERATED README generatedoutput INITIAL CODE initialcode

About

Create README from comments

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published