Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install instructions #32

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,18 +166,29 @@ fn main() {

## Running locally

Borgo is written in Rust, so you'll need `cargo`.
Borgo is written in Rust, so you'll need `cargo`. Install the borgo binary. It's called `compiler` and it will
be installed into your `.cargo/bin` folder.

```bash
cargo install --git https://github.com/borgo-lang/borgo
```

To compile all `.brg` files in the current folder:

```bash
$ cargo run -- build
compiler build
```

The compiler will generate `.go` files, which you can run as normal:

```bash
# generate a go.mod file if needed
# $ go mod init foo
# go mod init foo
$ go run .
```

Borgo generates a _valid_ go code, not necessarily _pretty_ go code. You can format it easily with gofmt:

```bash
gofmt -w .
```