summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-05-10 17:55:34 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-05-10 17:55:34 +0200
commit08556b95edf02b8fde068d2db215c63446479564 (patch)
treec6e413e66cd4959ec35b2ecf28b9002bd7cca5d3 /readme.md
parent447176eb86f88139f9974b789c03444245835874 (diff)
Simplify project by getting rid of workspacev0.1.0
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md70
1 files changed, 35 insertions, 35 deletions
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.
-<a id="org986db7c"></a>
+<a id="org920ad93"></a>
# Getting Started
-<a id="orgafa9ca9"></a>
+<a id="orga0a1fa1"></a>
## 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
-<a id="org549f1c0"></a>
+<a id="orgba2f24f"></a>
## Installation
-<a id="orge3db211"></a>
+<a id="orgcdc7511"></a>
### Prerequisites
@@ -121,7 +121,7 @@ all of the options, and is a great way to learn what all the commands do.
the OpenSSH daemon.
-<a id="org201706a"></a>
+<a id="org028a898"></a>
### Building Shackle
@@ -137,7 +137,7 @@ build from source.
cargo install --git https://code.worthe-it.co.za/shackle.git/ --force
-<a id="org7c15c50"></a>
+<a id="org04bfc1c"></a>
### 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
-<a id="orgbbb568c"></a>
+<a id="org42a08f6"></a>
### Set Shackle as your default shell
@@ -171,7 +171,7 @@ will be Shackle.
sudo usermod --shell $HOME/.cargo/bin/shackle-shell $USER
-<a id="orgba67b49"></a>
+<a id="orgee1f10f"></a>
# 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.
-<a id="orgecab73f"></a>
+<a id="org4ab94d8"></a>
# Development Guide
-<a id="org042c092"></a>
+<a id="org37992c2"></a>
## 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
-<a id="org47d18c8"></a>
+<a id="org435149f"></a>
## Running Tests
All unit tests are run with Cargo.
- cargo test --workspace
+ cargo test
-<a id="org93c4549"></a>
+<a id="orge2138f7"></a>
## Linting
@@ -253,7 +253,7 @@ And it can be run via Cargo.
cargo clippy
-<a id="org2f9ca48"></a>
+<a id="org2987255"></a>
## 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`
-<a id="orgc6e595d"></a>
+<a id="orgd145959"></a>
# Roadmap / Issue Tracker TODO list
-<a id="org63f61f9"></a>
+<a id="org90cf3d0"></a>
## MVP
@@ -303,7 +303,7 @@ After running this, the binary is available in `./target/release/shackle-shell`
- [X] help docs on all the commands
-<a id="org64e0c30"></a>
+<a id="orge18567c"></a>
## Post-MVP
@@ -324,7 +324,7 @@ After running this, the binary is available in `./target/release/shackle-shell`
- [ ] pijul support on other commands
-<a id="org2bca22d"></a>
+<a id="org3e0d656"></a>
# License