diff options
| author | Justin Wernick <justin@worthe-it.co.za> | 2023-06-02 10:53:07 +0200 |
|---|---|---|
| committer | Justin Wernick <justin@worthe-it.co.za> | 2023-06-02 10:53:07 +0200 |
| commit | 5eac40377ab8526717c6e4564bc1ab3067db68d8 (patch) | |
| tree | 674d8ec8a6d57870973b308cdb108a062f091795 /readme.org | |
| parent | f129dadf8ce4971f794ae325f610be3e8fdcbea8 (diff) | |
Updated readme to reference the new blog post
Diffstat (limited to 'readme.org')
| -rw-r--r-- | readme.org | 24 |
1 files changed, 21 insertions, 3 deletions
@@ -90,8 +90,18 @@ all of the options, and is a great way to learn what all the commands do. ** Installation +*** Background + +Shackle is designed to run on a Git server. The process of setting up your own +Git server, which is set up as described in the following two articles: + +- [[https://www.worthe-it.co.za/blog/2022-06-10-how-to-train-your-git-server.html][initial server setup]] +- [[https://www.worthe-it.co.za/blog/2023-06-02-leveling-up-your-git-server-sharing-repos.html][sharing repos]]. + *** Prerequisites +The following programs much be installed: + - Git - This is used for git operations which are passed through for the operation of =git push= and =git fetch=. @@ -104,8 +114,10 @@ all of the options, and is a great way to learn what all the commands do. *** Building Shackle -There is not yet a binary release of Shackle, so you need to build it yourself -from source. The easiest way to do this is using =cargo install=. +Binary releases of Shackle can be downloaded from [[https://codeberg.org/worthe-it/shackle-shell/releases/][Codeberg]]. + +You can also build it yourself from source. The easiest way to do this is using +=cargo install=. This requires a the Rust toolchain and a C compiler. See the Development Environment Setup section below for more information on environment setup to @@ -274,7 +286,7 @@ After running this, the binary is available in =./target/release/shackle-shell= - [X] clean up crates.io metadata - [X] crates.io friendly readme: needs to be markdown - [X] rename to something that isn't taken on crates.io (shackle-shell) -- [ ] publish to crates.io +- [X] publish to crates.io - [ ] project website - [ ] functions correctly when the git path isn't created with correct permissions yet @@ -285,6 +297,12 @@ After running this, the binary is available in =./target/release/shackle-shell= - [ ] pijul fetch and pijul push - [ ] pijul support on other commands +* Support + +If you get value from this project, consider supporting me on [[https://www.patreon.com/worthe_it][Patreon]]. Support +via Patreon helps to cover hosting, buying computer stuff, and will allow me to +spend more time writing articles and open source software. + * License Licensed under [[./LICENSE][MIT License]]. |