From b2ea48bf1d6533e91d6a1e3d6547edaaf67e70cb Mon Sep 17 00:00:00 2001 From: Kreyren Date: Fri, 31 Jan 2020 05:48:58 +0000 Subject: [PATCH] More documentation and stub for alternative repository management --- Cargo.toml | 4 +++- src/README.md | 4 ++++ src/bin/README.md | 1 + src/subcoms/README.md | 4 ++-- 4 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 src/bin/README.md diff --git a/Cargo.toml b/Cargo.toml index 57411dd..bda9e1c 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -15,4 +15,6 @@ clap = "2.33.0" # FIXME: Replace with latest once development is in gold log = "0.4.8" # FIXME: Replace with latest once development is in gold -die = "0.2.0" \ No newline at end of file +die = "0.2.0" +# Used for repository management as alternative to 'make' +cargo-make = "0.26.2" \ No newline at end of file diff --git a/src/README.md b/src/README.md index f2e733f..10a8aac 100644 --- a/src/README.md +++ b/src/README.md @@ -4,5 +4,9 @@ This is stub file used for various informations about the source that cannot be **FIXME:** Add Flow chart +**FIXME:** Add Dependency flow chart + +**FIXME:** Add Mindmap + ### References Rust source hierarchy - https://doc.rust-lang.org/cargo/reference/manifest.html#the-project-layout \ No newline at end of file diff --git a/src/bin/README.md b/src/bin/README.md new file mode 100644 index 0000000..9db469a --- /dev/null +++ b/src/bin/README.md @@ -0,0 +1 @@ +Standard directory recognized by cargo for alternative binaries to `main.rs` \ No newline at end of file diff --git a/src/subcoms/README.md b/src/subcoms/README.md index 0ae1260..134b1ea 100644 --- a/src/subcoms/README.md +++ b/src/subcoms/README.md @@ -1,3 +1,3 @@ -This directory is used for various subcommands used by zernif +non-standard directory used for various subcommands used by zernit -Note that this is non-standard directory which defines these subcommands as modules \ No newline at end of file +These are modules being used as subcommands from which `main.rs` points to \ No newline at end of file