diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e7bd5fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing + +The project is undergoing a transition from ad-hoc shell scripts (and manual stuff) to use [`bazel`](https://bazel.build/). + +To get started, install [`direnv`](https://direnv.net/) and [`bazelisk`](https://github.com/bazelbuild/bazelisk) (which will handle installing the appropriate version of `bazel` for you). + +## Build everything + +```sh +bazel build //... +``` + +## Build all packages + +```sh +bazel build //packages/... +``` + +## Build a specific package + +```sh +bazel build //packages/ +``` + +## (Explicitly) build package for "rootless" jailbreak (the default) + + +```sh +bazel build --//packages:jailbreak_type=rootless +``` + +## Build package for "rootful" jailbreak + + +```sh +bazel build --//packages:jailbreak_type=rootful +``` + +## TODO + +- [ ] some way to configure version better than hardcoding (CLI arg?) +- [ ] publish a package +- [ ] github actions/workflows to publish (and update workspace to pull `.debs`?) +- [ ] build website + - [ ] Stick w/ Jekyll - + - [ ] Migrate to 11ty - / + - [ ] build `Packages`/`Packages.gz` via bazel