From 17fe90c8d0f12b4eefd7d6b3037fe4cfed9e06dc Mon Sep 17 00:00:00 2001 From: "Dustin J. Mitchell" Date: Sat, 21 Nov 2020 19:47:40 -0500 Subject: [PATCH] poor excuse for documentation --- docs/src/SUMMARY.md | 3 +++ docs/src/installation.md | 3 +++ docs/src/usage.md | 4 ++++ 3 files changed, 10 insertions(+) create mode 100644 docs/src/installation.md create mode 100644 docs/src/usage.md diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index e499e5c62..1bfe24c75 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -1,3 +1,6 @@ # Summary +- [Installation](./installation.md) +- [Usage](./usage.md) +--- - [Development Notes](./development-notes.md) diff --git a/docs/src/installation.md b/docs/src/installation.md new file mode 100644 index 000000000..a597a11da --- /dev/null +++ b/docs/src/installation.md @@ -0,0 +1,3 @@ +# Installation + +As this is currently in development, installation is by cloning the repository and running "cargo build". diff --git a/docs/src/usage.md b/docs/src/usage.md new file mode 100644 index 000000000..39a73fc03 --- /dev/null +++ b/docs/src/usage.md @@ -0,0 +1,4 @@ +# Usage + +The main interface to your tasks is the `task` command, which supports various subcommands. +You can find a quick list of all subcommands with `task help`.