From 107afffb7608a786da8cea7f149bd11516109bcf Mon Sep 17 00:00:00 2001 From: Justin Wernick Date: Thu, 20 Apr 2023 21:52:42 +0200 Subject: Fill in an outline of what's planned for the readme --- readme.org | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'readme.org') diff --git a/readme.org b/readme.org index cfb6362..99e84f9 100644 --- a/readme.org +++ b/readme.org @@ -24,14 +24,30 @@ differences: # TODO +# When you login, you'll see the prompt > +# Type help to see the list of commands +# init my-awesome-repo will create the repo git//my-awesome-repo.git +# init --group my-group my-awesome-repo will create the repo +# git/my-group/my-awesome-repo.git in shared mode. +# list to see all your repos + +# From outside, git clone me@myserver:git/me/my-awesome-repo.git + ** Installation # TODO +# cargo install to build from source +# set as the user's shell + * Development Guide # TODO +# cargo build +# cargo test --workspace +# cargo clippy + * Roadmap / Issue Tracker TODO list ** MVP @@ -69,6 +85,7 @@ differences: - [X] proper licensing - [ ] all the getting started stuff in the readme +- [ ] publish to crates.io - [ ] project website - [ ] functions correctly when the git path isn't created yet - [ ] git archive with git upload-archive -- cgit v1.2.3