diff options
author | Lars Wirzenius <liw@liw.fi> | 2021-12-14 19:49:04 +0200 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2021-12-14 19:49:04 +0200 |
commit | 0d5c9b89cc3eafe1047537348e50bc0277d2db8e (patch) | |
tree | 8ae1da4eae530818b6b4852bac89196d9597ceb1 /README.md | |
parent | 8b31c8bc498f385d9876b6abc98e5768bc9dd5e5 (diff) | |
download | roadmap-0d5c9b89cc3eafe1047537348e50bc0277d2db8e.tar.gz |
chore: add repo to Cargo.toml, rename README to README.md
Sponsored-by: author
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..3aaf13d --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +-*-markdown-*- + +Produce directed acyclic graph representations of a project roadmap. +The idea is to show the steps needed to reach a goal, and the order +they need to be taken, but ignore due dates and other irrelevant +details. + +# Example + +~~~yaml +goal: + label: | + This is the end goal: + if we reach here, there + is nothing more to be + done in the project + depends: + - finished + - blocked + +finished: + status: finished + label: | + This task is finished; + the arrow indicates what + follows this task (unless + it's blocked) + +ready: + status: ready + label: | + This task is ready + to be done: it is not + blocked by anything + +next: + status: next + label: | + This task is chosen + to be done next + +blocked: + status: blocked + label: | + This task is blocked + and can't be done until + something happens + depends: + - ready + - next +~~~ + +To run: + +~~~sh +cargo run --bin roadmap2dot legend.yaml | dot -Tsvg > legend.svg +~~~ + +This will produce a graph like the one below. + +![](legend.svg "See yaml for textual version") + + +# Legalese + +Copyright 2019 Lars Wirzenius + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +“Software”), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, +TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE +SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +Fork this project to create your own MIT license that you can always +link to. |