Skip to content

Commit

Permalink
chore: add build instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
hakimifr committed Jan 23, 2025
1 parent 0558b92 commit fa38678
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
# ksau-oned-api
# ksau-go

[![Go Version](https://img.shields.io/badge/go-1.23.4-blue)](https://golang.org/doc/go1.23)

## Build Instruction
### To build this project, you need two important thing:
1. Private PGP key used to decrypt rclone.conf
2. The passphrase of the PGP key

### They should be placed under **crypto/** like so:
```
└───crypto
algo.go
placeholder.go
>> passphrase.txt ⌉ -- These files
>> privkey.pem ⌋ they are not provided by the repo
```

### Finally, install the dependencies and you're ready to build the project!
```
go mod tidy # install dependencies
make build # build the project
```

Depending on the OS you're on, you'll see `ksau-go` or `ksau-go.exe` generated
in the current working directory.

0 comments on commit fa38678

Please sign in to comment.