From 08556b95edf02b8fde068d2db215c63446479564 Mon Sep 17 00:00:00 2001 From: Justin Wernick Date: Wed, 10 May 2023 17:55:34 +0200 Subject: Simplify project by getting rid of workspace --- readme.md | 70 +++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 4c4b16b..469fb8d 100644 --- a/readme.md +++ b/readme.md @@ -1,23 +1,23 @@ # Table of Contents -1. [Getting Started](#org986db7c) - 1. [Usage](#orgafa9ca9) - 2. [Installation](#org549f1c0) - 1. [Prerequisites](#orge3db211) - 2. [Building Shackle](#org201706a) - 3. [Creating the required directory structure](#org7c15c50) - 4. [Set Shackle as your default shell](#orgbbb568c) -2. [Operating System Support](#orgba67b49) -3. [Development Guide](#orgecab73f) - 1. [Development Environment Setup](#org042c092) - 2. [Running Tests](#org47d18c8) - 3. [Linting](#org93c4549) - 4. [Building a Release Binary](#org2f9ca48) -4. [Roadmap / Issue Tracker TODO list](#orgc6e595d) - 1. [MVP](#org63f61f9) - 2. [Post-MVP](#org64e0c30) -5. [License](#org2bca22d) +1. [Getting Started](#org920ad93) + 1. [Usage](#orga0a1fa1) + 2. [Installation](#orgba2f24f) + 1. [Prerequisites](#orgcdc7511) + 2. [Building Shackle](#org028a898) + 3. [Creating the required directory structure](#org04bfc1c) + 4. [Set Shackle as your default shell](#org42a08f6) +2. [Operating System Support](#orgee1f10f) +3. [Development Guide](#org4ab94d8) + 1. [Development Environment Setup](#org37992c2) + 2. [Running Tests](#org435149f) + 3. [Linting](#orge2138f7) + 4. [Building a Release Binary](#org2987255) +4. [Roadmap / Issue Tracker TODO list](#orgd145959) + 1. [MVP](#org90cf3d0) + 2. [Post-MVP](#orge18567c) +5. [License](#org3e0d656) A shell for restricting access on a version control server. @@ -37,12 +37,12 @@ differences: - (coming soon!) Support for other other version control systems. - + # Getting Started - + ## Usage @@ -101,12 +101,12 @@ all of the options, and is a great way to learn what all the commands do. -h, --help Print help - + ## Installation - + ### Prerequisites @@ -121,7 +121,7 @@ all of the options, and is a great way to learn what all the commands do. the OpenSSH daemon. - + ### Building Shackle @@ -137,7 +137,7 @@ build from source. cargo install --git https://code.worthe-it.co.za/shackle.git/ --force - + ### Creating the required directory structure @@ -160,7 +160,7 @@ users have a `~/git` symlink in their home directory which actually points at chmod --recursive u=rwX,g=rwXs,o= ~/git/$GROUP - + ### Set Shackle as your default shell @@ -171,7 +171,7 @@ will be Shackle. sudo usermod --shell $HOME/.cargo/bin/shackle-shell $USER - + # Operating System Support @@ -182,12 +182,12 @@ currently tested, and there are currently no plans to do so. I would not expect it to work on Windows. - + # Development Guide - + ## Development Environment Setup @@ -231,16 +231,16 @@ environment ready. # Note: you need to log out and in again for the new group to take effect - + ## Running Tests All unit tests are run with Cargo. - cargo test --workspace + cargo test - + ## Linting @@ -253,7 +253,7 @@ And it can be run via Cargo. cargo clippy - + ## Building a Release Binary @@ -264,12 +264,12 @@ Release binaries should be built in release mode. After running this, the binary is available in `./target/release/shackle-shell` - + # Roadmap / Issue Tracker TODO list - + ## MVP @@ -303,7 +303,7 @@ After running this, the binary is available in `./target/release/shackle-shell` - [X] help docs on all the commands - + ## Post-MVP @@ -324,7 +324,7 @@ After running this, the binary is available in `./target/release/shackle-shell` - [ ] pijul support on other commands - + # License -- cgit v1.2.3