File tree Expand file tree Collapse file tree 3 files changed +17
-3
lines changed
Expand file tree Collapse file tree 3 files changed +17
-3
lines changed Original file line number Diff line number Diff line change @@ -18,7 +18,7 @@ opam pin git@github.com:shonfeder/nomad.git
1818If you project's name is =dingus=
1919
2020#+BEGIN_SRC sh
21- nomad new --bin dingus
21+ nomad new dingus
2222#+END_SRC
2323
2424And a scaffold for building the dingus executable will be created in the
@@ -46,6 +46,10 @@ nomad sync
4646And the dependencies declared in your project's =dune-project= will be synced
4747using opam.
4848
49+ ** Examples
50+
51+ For more examples of usage, see [[file:test/README.org][test/README.org]].
52+
4953* Plans and ideas
5054
5155See [[https://github.com/shonfeder/nomad/blob/master/project.org][project.org]].
Original file line number Diff line number Diff line change 1+ #+title: Examples
2+
3+ Relatively exhaustive (annotated and tested) examples of nomad's usage are
4+ available in the blackbox tests:
5+
6+ - [[file:new.t/run.t][Creating new projects]]
7+ - [[file:add.t/run.t][Adding components to a project]]
8+ - [[file:sync.t/run.t][Syncing a project's dependencies]]
9+ - [[file:config.t/][Inspecting and managing nomad's configuration]]
Original file line number Diff line number Diff line change 11Create an empty config to avoid searching into the runner environments file system
2+
23 $ mkdir . nomad && echo " ()" > . nomad/ config. sexp
34
4- When no config file is specified, use the nearest config dir
5+ When no config values are specified, use the nearest config dir
56
67 $ nomad config
78 ((author " Author Name" ) (username github-username)
89 (dev_packages
910 (merlin>= 4.6 . 1~ 5. 0preview utop ocp-indent ocp-index odoc odig)))
1011
11- Can read data from the nearest config dir
12+ Can read config overrides from the nearest config dir
1213
1314 $ echo ' ((author "Test Name") (username test-username))' > . nomad/ config. sexp
1415 $ nomad config
You can’t perform that action at this time.
0 commit comments