Add hopefully helpful readmes to examples

tweag · Dec 1, 2021 · 7c51a68 · 7c51a68
1 parent b20c737
commit 7c51a68
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/examples/toolchains/cc/README.md b/examples/toolchains/cc/README.md
@@ -0,0 +1,17 @@
+C++ Toolchain Example
+=====================
+
+This is an example C++ project that uses `rules_cc`. It should build and run both with or without Nix installed.
+
+# Usage
+
+To run the example with Nix, issue the following command:
+```
+nix-shell --command 'bazel run :hello'
+```
+
+To run the example without Nix, make sure you have Bazel installed, and issue the following command:
+```
+bazel run :hello
+```
+Note that if this command is run on NixOS, it will still use Nix. :-)
diff --git a/examples/toolchains/go/README.md b/examples/toolchains/go/README.md
@@ -0,0 +1,17 @@
+Go Toolchain Example
+====================
+
+This is an example Go project that uses `rules_go`. It should build and run both with or without Nix installed.
+
+# Usage
+
+To run the example with Nix, issue the following command:
+```
+nix-shell --command 'bazel run :hello'
+```
+
+To run the example without Nix, make sure you have Bazel installed, and issue the following command:
+```
+bazel run :hello
+```
+Note that if this command is run on NixOS, it will still use Nix. :-)