aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOndřej Čertík <ondrej@certik.us>2020-01-12 22:59:34 +0000
committerOndřej Čertík <ondrej@certik.us>2020-01-12 22:59:34 +0000
commit4f4c692ae97dfbf5bf769085e32bae5c7a9a7f5c (patch)
tree7bd58a1f560420e4c360670011ea0e22ad966292
parent88101d7128d80a929ab526058a5ef784e567d33a (diff)
parent2a2d040e3cda8ad1568e36e7a75ae06f9827e1df (diff)
downloadfpm-4f4c692ae97dfbf5bf769085e32bae5c7a9a7f5c.tar.gz
fpm-4f4c692ae97dfbf5bf769085e32bae5c7a9a7f5c.zip
Merge branch 'readme' into 'master'
Add Readme See merge request certik/fpm!7
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6e23c1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+# Fortran Package Manager
+
+A prototype version.
+
+## How to try it out
+
+Install Rust, then:
+```
+cargo build
+```
+Go to a test directory and execute:
+```
+cd tests/1
+../../target/debug/fpm build
+../../target/debug/fpm run
+```
+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