Skip to content

Commit 28fed3d

Browse files
committed
Update README to reflect build script changes
1 parent 6190aaa commit 28fed3d

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,34 @@
1-
# ottodocs
1+
# OttoDocs 🦦
22

33
[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
44

5-
`ottodocs` is a command-line tool written in Go that uses GPT-3 (and GPT-4 once the API is available) to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
5+
OttoDocs is a command-line tool written in Go that uses GPT-3 (and GPT-4 once the API is available) to automatically generate or add inline and markdown documentation for your code. It can parse a git repository or an individual file and create markdown documentation or add inline comments. The tool requires an [OpenAI API key](https://platform.openai.com/account/api-keys) to function.
66

7-
`ottodocs` utilizes the `just` command runner for building and running tasks, making it easy to use and maintain.
7+
OttoDocs utilizes the `just` command runner for building and running tasks, making maintaining the project easier. If you do not have `just` installed, see [here](https://just.systems/man/en/chapter_5.html) for installation methods.
88

99
## Installation
1010

11-
There are two methods to install `ottodocs` :
11+
There are two methods to install OttoDocs:
1212

1313
1. **Precompiled binaries:** Download the precompiled binaries from the [GitHub releases tab](https://github.com/chand1012/ottodocs/releases).
1414
2. **Build from source:** Clone the repo and build the binary by running the following commands:
1515

1616
```sh
1717
git clone https://github.com/chand1012/ottodocs.git
1818
cd ottodocs
19-
just build # will output binary to bin/otto. Copy the file to a directory in your PATH
19+
just build # will build to bin/ottodocs
20+
# or
21+
just install # will build & copy to $GOPATH/bin.
2022
```
2123

24+
If you want to build for all supported platforms, you can run the following command:
25+
26+
```sh
27+
just crossbuild
28+
```
29+
30+
This will build and compress binaries for all supported platforms and place them in the `dist` directory.
31+
2232
## Getting Started
2333

2434
First, you need to create an OpenAI API Key. If you do not already have an OpenAI account, you can create a new one and get some free credits to try it out. Once you have an account, you can create an API key by going to the [API Keys tab](https://platform.openai.com/account/api-keys) in your account settings.
@@ -32,7 +42,7 @@ otto login
3242
Optionally you can pass the API key as an argument to the command:
3343

3444
```sh
35-
otto login -p $OPENAI_API_KEY
45+
otto login --apikey $OPENAI_API_KEY
3646
```
3747

3848
Once that is complete, you can start generating documentation by running the following command:

0 commit comments

Comments
 (0)