Add README

Author: chand1012

.gitignore

@@ -1 +1,4 @@
 ottodocs
+bin/**
+*.zip
+*.tar.gz

.gptignore

@@ -2,3 +2,4 @@
 LICENSE
 go.mod
 go.sum
+docs/**

Justfile

@@ -2,7 +2,7 @@ default:
   just --list --unsorted
 
 build:
-  go build -v -o otto
+  go build -v -o bin/otto
 
 clean:
   rm -f otto
@@ -12,3 +12,43 @@ run *commands:
 
 cobra-docs:
   go run docs/gen_docs.go
+
+install: build
+  cp bin/otto $GOPATH/bin
+
+crossbuild:
+  #!/bin/bash
+
+  # Set the name of the output binary and Go package
+  BINARY_NAME="otto"
+  GO_PACKAGE="github.com/chand1012/ottodocs"
+
+  # Build for M1 Mac (Apple Silicon)
+  echo "Building for M1 Mac (Apple Silicon)"
+  env GOOS=darwin GOARCH=arm64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  zip "${BINARY_NAME}_darwin_arm64.zip" "${BINARY_NAME}"
+  rm "${BINARY_NAME}"
+
+  # Build for AMD64 Mac (Intel)
+  echo "Building for AMD64 Mac (Intel)"
+  env GOOS=darwin GOARCH=amd64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  zip "${BINARY_NAME}_darwin_amd64.zip" "${BINARY_NAME}"
+  rm "${BINARY_NAME}"
+
+  # Build for AMD64 Windows
+  echo "Building for AMD64 Windows"
+  env GOOS=windows GOARCH=amd64 go build -o "${BINARY_NAME}.exe" "${GO_PACKAGE}"
+  zip "${BINARY_NAME}_windows_amd64.zip" "${BINARY_NAME}.exe"
+  rm "${BINARY_NAME}.exe"
+
+  # Build for AMD64 Linux
+  echo "Building for AMD64 Linux"
+  env GOOS=linux GOARCH=amd64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  tar czvf "${BINARY_NAME}_linux_amd64.tar.gz" "${BINARY_NAME}"
+  rm "${BINARY_NAME}"
+
+  # Build for ARM64 Linux
+  echo "Building for ARM64 Linux"
+  env GOOS=linux GOARCH=arm64 go build -o "${BINARY_NAME}" "${GO_PACKAGE}"
+  tar czvf "${BINARY_NAME}_linux_arm64.tar.gz" "${BINARY_NAME}"
+  rm "${BINARY_NAME}"

README.md

@@ -0,0 +1,24 @@
+# ottodocs
+
+[![License: AGPL v3](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+
+`ottodocs` is a command-line tool written in Go that uses GPT-3 to automatically generate or add inline 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 to function.
+
+`ottodocs` utilizes the `just` command runner for building and running tasks, making it easy to use and maintain.
+
+## Installation
+
+There are two methods to install `ottodocs` :
+
+1. **Precompiled binaries:** Download the precompiled binaries from the [GitHub releases tab](https://github.com/chand1012/ottodocs/releases).
+2. **Build from source:** Clone the repo and build the binary by running the following commands:
+
+```sh
+git clone https://github.com/chand1012/ottodocs.git
+cd ottodocs
+just build # will output binary to bin/otto. Copy the file to a directory in your PATH
+```
+
+## Usage
+
+For detailed usage instructions, please refer to the [documentation](docs/otto.md).

cmd/doc.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+Copyright © 2023 Chandler <chandler@chand1012.dev>
 */
 package cmd
 

cmd/docs.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2023 NAME HERE <EMAIL ADDRESS>
+Copyright © 2023 Chandler <chandler@chand1012.dev>
 */
 package cmd
 

cmd/prompt.go

@@ -8,6 +8,7 @@ import (
 	"os"
 
 	"github.com/chand1012/git2gpt/prompt"
+	"github.com/pandodao/tokenizer-go"
 	"github.com/spf13/cobra"
 )
 
@@ -72,7 +73,7 @@ var promptCmd = &cobra.Command{
 			fmt.Println(output)
 		}
 		if estimateTokens {
-			fmt.Printf("Estimated number of tokens: %d\n", prompt.EstimateTokens(output))
+			fmt.Printf("Estimated number of tokens: %d\n", tokenizer.MustCalToken(output))
 		}
 	},
 }

docs/.gptignore

@@ -0,0 +1 @@
+gen_docs.go