summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorKevin K <kbknapp@gmail.com>2016-06-03 22:14:09 -0400
committerKevin K <kbknapp@gmail.com>2016-06-03 22:14:09 -0400
commit6a30e674117c02a54307b1fe8c7f1cc16da06e23 (patch)
tree7c96c867c7f964ed93fd439185036497e937f5d9 /README.md
parentb98ccbbc019a328138633b8456f9ba0976a8bc02 (diff)
Adds a Makefile for building modules
One can now type: ``` $> make ``` Which builds all the modules and places them in a `out/` directory of the project root for easy finding. Alternatively one can type: ``` $> make $module ``` Where `$module` is one of the `imag-$module` names, such as `counter`, `link`, etc. To clean up the `out/` directory it's `$> make clean`
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 12 insertions, 12 deletions
diff --git a/README.md b/README.md
index 351d39a0..449477aa 100644
--- a/README.md
+++ b/README.md
@@ -89,26 +89,26 @@ provided (as the libraries are work-in-progress).
### Building
-To build a single module:
-```
-$> cd <imag-proj-dir>/imag-<module>
-$> cargo build
-```
-It may be tiresome to build all the modules by hand, but one can do something
-like this:
+One can build all the modules simply by running `make` which defaults to building all the modules
+and placing them in the `out/` directory of the project root.
+
```
-$> for dir in \
->$(find ./ -maxdepth 1 -path "./imag-*" -name "imag-*" -type d)
->do
->pushd $dir; cargo build; popd
->done
+$> make
+ ...
+$> ls out/
+imag-counter imag-link imag-notes imag-store imag-tag imag-view
```
+Building all the modules may take some time, so alternatively one can build only a specific module
+by runing `$> make $module` where `$module` is one of the `imag-$module` names, such as `counter`,
+`link`, etc.
+
### Running
To run imag, simply call `./bin/imag`. This script has a function to search for
modules, which utilizes an environment variable called `IMAG_IS_THE_SHIT`.
To run imag with all components:
+
```
$> IMAG_IS_THE_SHIT=$(pwd) ./bin/imag
```