Skip to content

Commit

Permalink
feat: update docs (#65)
Browse files Browse the repository at this point in the history
  • Loading branch information
finn-qarik authored Apr 16, 2024
1 parent 0554e25 commit 2eac036
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 13 deletions.
14 changes: 1 addition & 13 deletions projects/bzl7/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
# bzl7

This project can execute various C++ and python targets with different gcc toolchains using bazel 7.

Check the `.bazelrc` file to see what configurations are supported.

## Go

We use Gazelle to generate the `BUILD.bazel` files for this project. Simply do:
```
# generates the BUILD files
bazel run gazelle
# executes the binary
bazel run //go/gazelle
```
This is the root of the `bzl7` project. Check each language folder for various examples.
7 changes: 7 additions & 0 deletions projects/bzl7/cpp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# cpp

This project can execute various C++ and python targets with different gcc toolchains using bazel 7.

Check the `.bazelrc` file to see what configurations are supported.

For the `boost` example, we rely on Nix providing the dependencies.
9 changes: 9 additions & 0 deletions projects/bzl7/go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# go

We use Gazelle to generate the `BUILD.bazel` files for this project. Simply do:
```
# generates the BUILD files
bazel run gazelle
# executes the binary
bazel run //go/gazelle
```
23 changes: 23 additions & 0 deletions projects/bzl7/python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# python

## hello world

It is possible to execute this script using various toolchains:
```
bazel run --config=python310 //python/hello_world:main
bazel run --config=python311 //python/hello_world:main
bazel run --config=python312 //python/hello_world:main
```

## pip example
To update the requirements file, simply run:
```
bazel run //python/pip:python_requirements.update
```

Now you may execute:
```
bazel run //python/pip:main
```

Note only the default toolchain is supported currently.

0 comments on commit 2eac036

Please sign in to comment.