From 2a2d040e3cda8ad1568e36e7a75ae06f9827e1df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20=C4=8Cert=C3=ADk?= Date: Sun, 12 Jan 2020 15:56:39 -0700 Subject: Add more documentation --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3