readme: Add an example of examples

Closes #291.
nix-community · Jul 1, 2023 · a8906d2 · a8906d2
1 parent df10963
commit a8906d2
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -268,6 +268,23 @@ See: [./examples](./examples).
 
 ## Tips & Tricks
 
+### Building a particular example
+
+If you want to build only a particular example, use:
+
+``` nix
+naersk.buildPackage {
+  pname = "your-example-name";
+  src = ./.;
+
+  overrideMain = old: {
+    preConfigure = ''
+      cargo_build_options="$cargo_build_options --example your-example-name"
+    '';
+  };
+}
+```
+
 ### Using OpenSSL
 
 If your application uses OpenSSL (making the build process fail), try:

diff --git a/README.tpl.md b/README.tpl.md
@@ -232,6 +232,23 @@ See: [./examples](./examples).
 
 ## Tips & Tricks
 
+### Building a particular example
+
+If you want to build only a particular example, use:
+
+``` nix
+naersk.buildPackage {
+  pname = "your-example-name";
+  src = ./.;
+
+  overrideMain = old: {
+    preConfigure = ''
+      cargo_build_options="$cargo_build_options --example your-example-name"
+    '';
+  };
+}
+```
+
 ### Using OpenSSL
 
 If your application uses OpenSSL (making the build process fail), try: