diff options
Diffstat (limited to 'readme.md')
-rw-r--r-- | readme.md | 70 |
1 files changed, 35 insertions, 35 deletions
@@ -1,23 +1,23 @@ # Table of Contents -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) +1. [Getting Started](#org9c3903e) + 1. [Usage](#org6fa9d8a) + 2. [Installation](#org10b2c96) + 1. [Prerequisites](#orgd426ed1) + 2. [Building Shackle](#orgb7eee70) + 3. [Creating the required directory structure](#orgf8fd81a) + 4. [Set Shackle as your default shell](#org58e1057) +2. [Operating System Support](#org8418be0) +3. [Development Guide](#org8b93b3d) + 1. [Development Environment Setup](#org6250a5d) + 2. [Running Tests](#org7f14941) + 3. [Linting](#orgc006671) + 4. [Building a Release Binary](#orgcd5123a) +4. [Roadmap / Issue Tracker TODO list](#orgba8330a) + 1. [MVP](#org565bb14) + 2. [Post-MVP](#org50cfb78) +5. [License](#org013cf1e) 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="org920ad93"></a> +<a id="org9c3903e"></a> # Getting Started -<a id="orga0a1fa1"></a> +<a id="org6fa9d8a"></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="orgba2f24f"></a> +<a id="org10b2c96"></a> ## Installation -<a id="orgcdc7511"></a> +<a id="orgd426ed1"></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="org028a898"></a> +<a id="orgb7eee70"></a> ### Building Shackle @@ -134,10 +134,10 @@ build from source. # This installs to Cargo's default, which is ~/.cargo/bin. Consider using the # --root option to install it somewhere that makes more sense for your server. - cargo install --git https://code.worthe-it.co.za/shackle.git/ --force + cargo install shackle-shell -<a id="org04bfc1c"></a> +<a id="orgf8fd81a"></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="org42a08f6"></a> +<a id="org58e1057"></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="orgee1f10f"></a> +<a id="org8418be0"></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="org4ab94d8"></a> +<a id="org8b93b3d"></a> # Development Guide -<a id="org37992c2"></a> +<a id="org6250a5d"></a> ## Development Environment Setup @@ -231,7 +231,7 @@ environment ready. # Note: you need to log out and in again for the new group to take effect -<a id="org435149f"></a> +<a id="org7f14941"></a> ## Running Tests @@ -240,7 +240,7 @@ All unit tests are run with Cargo. cargo test -<a id="orge2138f7"></a> +<a id="orgc006671"></a> ## Linting @@ -253,7 +253,7 @@ And it can be run via Cargo. cargo clippy -<a id="org2987255"></a> +<a id="orgcd5123a"></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="orgd145959"></a> +<a id="orgba8330a"></a> # Roadmap / Issue Tracker TODO list -<a id="org90cf3d0"></a> +<a id="org565bb14"></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="orge18567c"></a> +<a id="org50cfb78"></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="org3e0d656"></a> +<a id="org013cf1e"></a> # License |