summaryrefslogtreecommitdiff
path: root/readme.org
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-04-20 21:52:42 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-04-20 21:52:42 +0200
commit107afffb7608a786da8cea7f149bd11516109bcf (patch)
treefa8b2dcda4ef5e1278a17f674d7b29e16d907185 /readme.org
parent2c983efe18b5b24f1d839119ca56548d816745a4 (diff)
Fill in an outline of what's planned for the readme
Diffstat (limited to 'readme.org')
-rw-r--r--readme.org17
1 files changed, 17 insertions, 0 deletions
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/<username>/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