https://github.com/utility-code/code_to_readme

Create README from comments
https://github.com/utility-code/code_to_readme

Last synced: 7 months ago
JSON representation

Create README from comments

• Host: GitHub
• URL: https://github.com/utility-code/code_to_readme
• Owner: utility-code
• Created: 2019-04-28T23:59:20.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-09-15T08:00:01.000Z (over 6 years ago)
• Last Synced: 2024-04-28T12:43:25.408Z (over 1 year ago)
• Language: Jupyter Notebook
• Homepage:
• Size: 424 KB
• Stars: 19
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 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

```bash

python main.py -p 

```

>For now this program only supports python.

## Side comments

- Initial file

- Output file

**GENERATED README**

![generatedoutput](output/gen.png)

**INITIAL CODE**

![initialcode](output/code.png)