summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7a8ae1e..c893911 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,33 @@
A collection of rules for building Rust libraries, binaries and unit tests.
+## How to use this repository
+There are two ways to import this repository. You can generate your
+`repos.json` from a template (`repos.template.json`) by importing
+the `rules-rust` repository with the tool `just-import-git`
+
+```sh
+$ just-import-git -C repos.template.json --as rules-rust -b master https://github.com/just-buildsystem/rules-rust > repos.json
+```
+
+Alternatively, the `rules-rust` repository can be added manually to
+your `repos.json`.
+
+``` jsonc
+...
+ , "rules-rust":
+ { "repository":
+ { "type": "git"
+ , "branch": "master"
+ , "repository": "https://github.com/just-buildsystem/rules-rust"
+ , "commit": "1a8211bda5c14ef0b2bff3af062c049d5598f02f"
+ , "subdir": "rules"
+ }
+ }
+...
+```
+
+
### `["rust", "binary"]`
A Rust binary.