summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
authorAlberto Sartori <alberto.sartori@huawei.com>2024-06-25 16:26:10 +0200
committerAlberto Sartori <alberto.sartori@huawei.com>2024-06-28 20:28:37 +0200
commit4d18d2723a28bb8e262920330335f046d94dac97 (patch)
tree399178f6e5ff82e6600ae2c90d7020e5cf5e7c89 /doc/README.md
parent20fab4540271abf9216bb22f604e7d48800e4e0b (diff)
downloadrules-rust-4d18d2723a28bb8e262920330335f046d94dac97.tar.gz
rules-rust: add "getting-started" tutorial
Through this tutorial the user will learn how to define Rust binaries, libraries, tests and the default toolchain configuration.
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..ddd9fea
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,8 @@
+# Prerequisites
+
+The tutorials aim to explain the rules' usage and not learn Rust or
+the `Justbuild` tool. Therefore, the user is assumed to know the Rust
+programming language and `Justbuild`.
+
+A `rustc` compiler must be installed and accessible in your
+environment.