Skip to content

Commit e3fe315

Browse files
committed
Add basic README
1 parent c3af5d7 commit e3fe315

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# rules_mojo
2+
3+
This repository provides rules for building
4+
[Mojo](https://www.modular.com/mojo) projects using
5+
[Bazel](https://bazel.build).
6+
7+
## Quick setup
8+
9+
Copy the latest `MODULE.bazel` snippet from [the releases
10+
page](https://github.com/modular/rules_mojo/releases).
11+
12+
Currently `rules_mojo` requires `bzlmod` and bazel 8.x or later.
13+
14+
## Example
15+
16+
```bzl
17+
load("@rules_mojo//mojo:mojo_binary.bzl", "mojo_binary")
18+
19+
mojo_binary(
20+
name = "hello_mojo",
21+
srcs = ["hello_mojo.mojo"],
22+
)
23+
```
24+
25+
See the [tests](https://github.com/modular/rules_mojo/tree/main/tests)
26+
directory for more examples.

0 commit comments

Comments
 (0)