aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOndřej Čertík <ondrej@certik.us>2020-01-12 15:56:39 -0700
committerOndřej Čertík <ondrej@certik.us>2020-01-12 15:56:39 -0700
commit2a2d040e3cda8ad1568e36e7a75ae06f9827e1df (patch)
tree7bd58a1f560420e4c360670011ea0e22ad966292 /README.md
parent9784234b728c64599d029669beea2897f5c02961 (diff)
downloadfpm-2a2d040e3cda8ad1568e36e7a75ae06f9827e1df.tar.gz
fpm-2a2d040e3cda8ad1568e36e7a75ae06f9827e1df.zip
Add more documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 272a784..e6e23c1 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
A prototype version.
-# How to try
+## How to try it out
Install Rust, then:
```
@@ -19,3 +19,14 @@ And the same in the other test directory (one can also call `run` directly):
cd tests/2
../../target/debug/fpm run
```
+
+## Development Details
+
+The command line interface (CLI) program `fpm` is build according to the
+following Rust CLI tutorial:
+
+https://rust-cli.github.io/book/index.html
+
+and the user API is inspired by Cargo. Here is Cargo project layout:
+
+https://doc.rust-lang.org/cargo/guide/project-layout.html