summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-10-27 11:19:33 +0200
committerMatthias Beyer <mail@beyermatthias.de>2016-10-27 14:08:17 +0200
commit821f0c75da4d6b84099c5477f3019b3cd152b25a (patch)
treedaf06b7377bcd0a1e5a4fe95b5b334bf3aae3dc4 /README.md
parente8f61dd03bffba9b69ca31bf55d327ccc3966b4a (diff)
Rewrite "Running"
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 6 insertions, 24 deletions
diff --git a/README.md b/README.md
index dd0108bd..242d6298 100644
--- a/README.md
+++ b/README.md
@@ -70,30 +70,12 @@ The `Multi` targets are callable for each sub-crate. For example you can call
### Running
-To test out a single module, simply using `cargo run -- <options>` in the
-respective directory will do the trick.
-But you can also `make <module>` and call the binary on the commandline.
-For using it "normally", install the
-binaries as described above, as well as the imag-binary:
-
-```
-$> make install
-```
-
-The installation root of the binaries may not yet be in your $PATH.
-To see where this installation root is check out `man cargo-install`.
-To change the $PATH in bash:
-
-```bash
-$> PATH=$PATH:~/.cargo/bin
-$> imag --help
-```
-
-To test, simply add `--help` to one of the above commands:
-
-```bash
-$> imag counter --help
-```
+After you build the module you want to play with, you can simply call the binary
+itself with the `--help` flag, to get some help what the module is capable of.
+
+If you installed the module, you can either call `imag-<modulename>` (if the
+install-directory is in your `$PATH`), or install the `imag` binary to call `imag
+<modulename>` (also if everything is in your `$PATH`).
## Staying up-to-date