From 0d5c9b89cc3eafe1047537348e50bc0277d2db8e Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Tue, 14 Dec 2021 19:49:04 +0200 Subject: chore: add repo to Cargo.toml, rename README to README.md Sponsored-by: author --- Cargo.toml | 1 + README | 88 -------------------------------------------------------------- README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 89 insertions(+), 88 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/Cargo.toml b/Cargo.toml index 541cf4b..76b4c2f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,6 +5,7 @@ authors = ["Lars Wirzenius "] edition = "2018" license = "MIT-0" description = "model a project roadmap as a directed acyclic graph" +repostiory = "https://gitlab.com/larswirzenius/roadmap" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html diff --git a/README b/README deleted file mode 100644 index 3aaf13d..0000000 --- a/README +++ /dev/null @@ -1,88 +0,0 @@ --*-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. 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. -- cgit v1.2.1