Skip to content

Commit

Permalink
Added a Getting Started section to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdanwan committed Sep 8, 2024
1 parent e2edff7 commit 076e399
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,47 +3,49 @@
## Table of Contents

1. [What is gimme_readme?][1-what-is-gimme-readme]
2. [Dependencies][2-dependencies]
2. [Getting Started][2-getting-started]
3. [Example Usage][3-example-usage]
4. [Contributing][4-contributing]

## 1. What is gimme_readme?

`gimme_readme` is a command-line tool that uses `OpenAI` to generate a `README.md` file that explains a given source code file.

## 2. Dependencies
## 2. Getting Started

To use the `gimme_readme`, you must do the following:
To use the `gimme_readme`, you must:

1. Install the latest version of [Python `3`, which comes with the `PIP` package manager](https://www.python.org/downloads/) (this will _not_ work with earlier versions of `Python`).
2. Install [openai] via the following command:

```sh
pip install openai
```

- NOTE: If you are on `Windows`, you must run this command as an `Administrator`.

3. Have a copy of `gr.py`, the main source file which will handle creating a `README.md` file based on your source code.
1. Install the latest version of [node](https://nodejs.org/en/download/package-manager) for your `operating system`.
2. Run `npm i -g gimme_readme`, which installs `gimme_readme` globally.

## 3. Example Usage

### On Linux / Mac OS
### Display all details

```sh
./gr.py FILE
gr
```

### On Windows
### Display version number

```sh
py ./gr.py FILE
# Can do this
gr -v
# Or this
gr --version
```

## 4. Contributing

Contributions to this project is welcomed! Please look for any [issues](https://github.com/peterdanwan/gimme_readme/issues)
Contributions to this project are welcomed!

We ask that you first check to see if the issue you've encountered or feature you wish to add is under the existing list of [issues](https://github.com/peterdanwan/gimme_readme/issues).

If your issue or suggested feature is already, please add onto the existing issue by adding your comments or making `pull request` with what you believe to be a valid change to the code.

Otherwise, if your issue or suggestion is not already list, please feel free to create a new issue, and if possible create a `pull request` that you think will resolve your issue.

[1-what-is-gimme-readme]: #1-what-is-gimme_readme
[2-dependencies]: #2-dependencies
[2-getting-started]: #2-getting-started
[3-example-usage]: #3-example-usage
[4-contributing]: #4-contributing
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "A CLI tool that generates a markdown file that explains your code using AI",
"author": "Peter Wan",
"license": "MIT",
"main": "gr.js",
"main": "_gr.js",
"bin": {
"gr": "./src/_gr.js"
},
Expand All @@ -21,7 +21,8 @@
"ai",
"chat-completion",
"learning",
"README.md"
"README.md",
"aryan"
],
"bugs": {
"url": "https://github.com/peterdanwan/gimme_readme/issues"
Expand Down

0 comments on commit 076e399

Please sign in to comment.