Skip to content

Document source build prerequisites #175

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.

Sign up for GitHub

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

Open
paulsmith wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document source build prerequisites #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you prefer to develop directly on your host machine, follow the steps below.
- Go 1.21+
- Node.js 18+
- Python 3.9+ (for Python client development)
- Java 21+ and Gradle 8+ (for Java client development)
- Java 21+ (required for the default `make` target and Java client development)
- GitHub CLI (optional, for managing issues/PRs from terminal):
- macOS: `brew install gh`
- Linux: `sudo apt install gh` or `sudo dnf install gh`
Expand All @@ -33,7 +33,9 @@ make
make test
```

This installs npm dependencies, builds the vibium binary and the JS client, downloads Chrome for Testing (if needed), and runs the test suite.
`make` installs npm dependencies and builds the vibium binary, JS client, and Java client. On a fresh checkout, it needs network access for `npm install` and for the Gradle wrapper to download Gradle.

`make test` downloads Chrome for Testing (if needed) and runs the full test suite. If you are only working on the Go binary or JS client, use `make build-go` or `make build-js` to avoid the Java build.

---

Expand Down
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,8 @@ bro.stop();
## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.
Source builds require Go, Node.js/npm, and Java 21 because the default `make`
target builds the Go binary, JS client, and Java client.

---

Expand Down