Format readme code blocks using fences to indicate language

1 files changed, 136 insertions, 118 deletions

diff --git a/README.md b/README.md
index cc05fa8..6e0bfc1 100644
--- a/README.md
+++ b/README.md
@@ -5,18 +5,17 @@ A shell for restricting access on a version control server.
 This is intended as a replacement for [Git Shell](https://git-scm.com/docs/git-shell), but with a few opinionated
 differences:
 
--   Additional commands, like creating new repos, are built in. No extension with
-    shell scripts.
--   Strict enforcement of a specified directory structure. Git push / pull
-    commands only work for these paths. New repos are created in these paths.
-    -   Private git repos are created in `~/git/<username>/<reponame>.git`
-    -   Shared git repos are created in `~/git/<groupname>/<reponame>.git`
--   Better interactive UX than Git Shell, including:
-    -   Command history (limited to the current session).
-    -   Emacs-style shortcuts (eg `Ctrl+a` to move cursor to the beginning of line).
-    -   Docs available for all commands, available in the shell itself.
--   (coming soon!) Support for other other version control systems.
-
+- Additional commands, like creating new repos, are built in. No extension with
+  shell scripts.
+- Strict enforcement of a specified directory structure. Git push / pull
+  commands only work for these paths. New repos are created in these paths.
+  - Private git repos are created in `~/git/<username>/<reponame>.git`
+  - Shared git repos are created in `~/git/<groupname>/<reponame>.git`
+- Better interactive UX than Git Shell, including:
+  - Command history (limited to the current session).
+  - Emacs-style shortcuts (eg `Ctrl+a` to move cursor to the beginning of line).
+  - Docs available for all commands, available in the shell itself.
+- (coming soon!) Support for other other version control systems.
 
 # Getting Started
 
@@ -27,55 +26,64 @@ server, where the user connects over SSH (see the Installation section below).
 
 When you log in over SSH, you'll see a prompt, ready for you to type commands.
 
-    >
+```sh
+>
+```
 
 You can see the built in help by running the `help` command.
 
-    > help
-    Usage: <COMMAND>
-    
-    Commands:
-      init              Create a new repository
-      list              List all repositories available
-      set-description   Sets the description of a repository, as shown in the CLI listing and web interfaces
-      set-branch        Sets the main branch of the repository
-      exit              Quit the shell
-      git-upload-pack   Server side command required to git fetch from the server
-      git-receive-pack  Server side command required by git push to the server
-      help              Print this message or the help of the given subcommand(s)
-    
-    Options:
-      -h, --help  Print help
+```
+> help
+Usage: <COMMAND>
+
+Commands:
+  init              Create a new repository
+  list              List all repositories available
+  set-description   Sets the description of a repository, as shown in the CLI listing and web interfaces
+  set-branch        Sets the main branch of the repository
+  exit              Quit the shell
+  git-upload-pack   Server side command required to git fetch from the server
+  git-receive-pack  Server side command required by git push to the server
+  help              Print this message or the help of the given subcommand(s)
+
+Options:
+  -h, --help  Print help
+```
 
 The `init` command is used to create a new repo. In its simplest form, you just
 provide it with the name of your new repo. This will create a git repo with
 individual ownership.
 
-    > init awesome-project-idea
-    Successfully created "git/shukkie/awesome-project-idea.git"
+```
+> init awesome-project-idea
+Successfully created "git/shukkie/awesome-project-idea.git"
+```
 
 The path given here is relative to your home directory. So the full URL to clone
 this repo is `<username>@<server domain>:<git path>`
 
-    $ git clone shukkie@example.com:git/shukkie/awesome-project-idea.git
+```sh
+git clone shukkie@example.com:git/shukkie/awesome-project-idea.git
+```
 
 You can learn its advanced options by using the `--help` flag. This works for
 all of the options, and is a great way to learn what all the commands do.
 
-    > init --help
-    Create a new repository
-    
-    Usage: init [OPTIONS] <REPO_NAME>
-    
-    Arguments:
-      <REPO_NAME>  Name of the new repository
-    
-    Options:
-          --group <GROUP>              Share repository ownership with the specified group (user must be a member of the group)
-          --description <DESCRIPTION>  Sets the description of the repository, as shown in the CLI listing and web interfaces
-          --branch <BRANCH>            Sets the main branch of the repository [default: main]
-      -h, --help                       Print help
+```
+> init --help
+Create a new repository
 
+Usage: init [OPTIONS] <REPO_NAME>
+
+Arguments:
+  <REPO_NAME>  Name of the new repository
+
+Options:
+      --group <GROUP>              Share repository ownership with the specified group (user must be a member of the group)
+      --description <DESCRIPTION>  Sets the description of the repository, as shown in the CLI listing and web interfaces
+      --branch <BRANCH>            Sets the main branch of the repository [default: main]
+  -h, --help                       Print help
+```
 
 ## Installation
 
@@ -84,22 +92,22 @@ all of the options, and is a great way to learn what all the commands do.
 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:
 
--   [initial server setup](https://www.worthe-it.co.za/blog/2022-06-10-how-to-train-your-git-server.html)
--   [sharing repos](https://www.worthe-it.co.za/blog/2023-06-02-leveling-up-your-git-server-sharing-repos.html).
+- [initial server setup](https://www.worthe-it.co.za/blog/2022-06-10-how-to-train-your-git-server.html)
+- [sharing repos](https://www.worthe-it.co.za/blog/2023-06-02-leveling-up-your-git-server-sharing-repos.html).
 
 ### 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`.
-    -   Git must be installed, with the `git-upload-pack` and `git-receive-pack`
-        executables on the path.
--   SSH
-    -   I assume users will be connecting over SSH. This is not enforced by the
-        shell, but is the primary use case I have in mind. I have tested this using
-        the OpenSSH daemon.
+- Git
+  - This is used for git operations which are passed through for the operation
+    of `git push` and `git fetch`.
+  - Git must be installed, with the `git-upload-pack` and `git-receive-pack`
+    executables on the path.
+- SSH
+  - I assume users will be connecting over SSH. This is not enforced by the
+    shell, but is the primary use case I have in mind. I have tested this using
+    the OpenSSH daemon.
 
 
 ### Building Shackle
@@ -113,10 +121,11 @@ This requires a the Rust toolchain and a C compiler. See the Development
 Environment Setup section below for more information on environment setup to
 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 shackle-shell
-
+```sh
+# 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 shackle-shell
+```
 
 ### Creating the required directory structure
 
@@ -129,15 +138,16 @@ the actual shared location for your git repos. For example, on my repo, all git
 users have a `~/git` symlink in their home directory which actually points at
 `/srv/git`.
 
-    mkdir -p ~/git/$USER
-    chmod --recursive u=rwX,g=,o= ~/git/$USER
-    
-    # Note that this should be a group you're actually a member of!
-    GROUP=my-group
-    mkdir -p ~/git/$GROUP
-    chown --recursive $USER:$GROUP ~/git/$GROUP
-    chmod --recursive u=rwX,g=rwXs,o= ~/git/$GROUP
+```sh
+mkdir -p ~/git/$USER
+chmod --recursive u=rwX,g=,o= ~/git/$USER
 
+# Note that this should be a group you're actually a member of!
+GROUP=my-group
+mkdir -p ~/git/$GROUP
+chown --recursive $USER:$GROUP ~/git/$GROUP
+chmod --recursive u=rwX,g=rwXs,o= ~/git/$GROUP
+```
 
 ### Set Shackle as your default shell
 
@@ -145,8 +155,9 @@ The next step is to set the default shell of your user to Shackle. This will
 mean that if you login as the user, for example over ssh, then the default shell
 will be Shackle.
 
-    sudo usermod --shell $HOME/.cargo/bin/shackle-shell $USER
-
+```sh
+sudo usermod --shell $HOME/.cargo/bin/shackle-shell $USER
+```
 
 # Operating System Support
 
@@ -161,69 +172,76 @@ it to work on Windows.
 
 ## Development Environment Setup
 
--   Rust
-    -   This project is built using the Rust programming language, and its build
-        tool Cargo. Information on how to install these tools is available on [the
-        Rust website](https://www.rust-lang.org/learn/get-started).
--   C Compiler
-    -   This is used to built one of the dependencies, libgit2. This can be
-        obtained from your operating system's package manager.
--   Docker
-    -   Some of the tests use Docker to create a simulated environment. This can be
-        obtained from your operating system's package manager, or the [Docker
-        website](https://www.docker.com/).
-    -   Docker must be installed, with the `docker` executable on the path.
-    -   Your user must have permission to use docker, including building and running
-        Docker containers.
--   Git
-    -   Some of the tests use Git to test the end to end functionality of the
-        shell. This can be obtained from your operating system's package manager, or
-        the [Git website](https://git-scm.com/).
-    -   Git must be installed, with the `git` executable on the path.
--   SSH
-    -   Some of the tests use an SSH client to test the end to end functionality of
-        the shell. I have tested this with OpenSSH, which can be obtained from your
-        operating system's package manager, or the [Git website](https://git-scm.com/).
-    -   with the `ssh` executable on the path.
+- Rust
+  - This project is built using the Rust programming language, and its build
+    tool Cargo. Information on how to install these tools is available on [the
+    Rust website](https://www.rust-lang.org/learn/get-started).
+- C Compiler
+  - This is used to built one of the dependencies, libgit2. This can be
+    obtained from your operating system's package manager.
+- Docker
+  - Some of the tests use Docker to create a simulated environment. This can be
+    obtained from your operating system's package manager, or the [Docker
+    website](https://www.docker.com/).
+  - Docker must be installed, with the `docker` executable on the path.
+  - Your user must have permission to use docker, including building and running
+    Docker containers.
+- Git
+  - Some of the tests use Git to test the end to end functionality of the
+    shell. This can be obtained from your operating system's package manager, or
+    the [Git website](https://git-scm.com/).
+  - Git must be installed, with the `git` executable on the path.
+- SSH
+  - Some of the tests use an SSH client to test the end to end functionality of
+    the shell. I have tested this with OpenSSH, which can be obtained from your
+    operating system's package manager, or the [Git website](https://git-scm.com/).
+  - with the `ssh` executable on the path.
 
 If you're running Arch Linux, these are the steps you'll need to get your
 environment ready.
 
-    sudo pacman -S rustup docker git openssh gcc
-    
-    # Rust
-    rustup default stable
-    
-    # Docker
-    sudo usermod -a -G docker $USER
-    sudo systemctl start docker.service
-    
-    # Note: you need to log out and in again for the new group to take effect
+```sh
+sudo pacman -S rustup docker git openssh gcc
+
+# Rust
+rustup default stable
+
+# Docker
+sudo usermod -a -G docker $USER
+sudo systemctl start docker.service
 
+# 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
-
+```sh
+cargo test
+```
 
 ## Linting
 
 Clippy should be used for linting. This can be installed using Rustup.
 
-    rustup component add clippy
+```sh
+rustup component add clippy
+```
 
 And it can be run via Cargo.
 
-    cargo clippy
-
+```sh
+cargo clippy
+```
 
 ## Building a Release Binary
 
 Release binaries should be built in release mode.
 
-    cargo build --release
+```sh
+cargo build --release
+```
 
 After running this, the binary is available in `./target/release/shackle-shell`
 
@@ -232,15 +250,15 @@ After running this, the binary is available in `./target/release/shackle-shell`
 
 ## Post-MVP
 
--   [ ] project website
--   [ ] functions correctly when the git path isn't created with correct
-    permissions yet
--   [ ] git archive with git upload-archive
--   [ ] git config management around protected branches
--   [ ] move a repo to a different group
--   [ ] housekeeping git tasks (git fsck, git gc)
--   [ ] pijul fetch and pijul push
--   [ ] pijul support on other commands
+- [ ] project website
+- [ ] functions correctly when the git path isn't created with correct
+      permissions yet
+- [ ] git archive with git upload-archive
+- [ ] git config management around protected branches
+- [ ] move a repo to a different group
+- [ ] housekeeping git tasks (git fsck, git gc)
+- [ ] pijul fetch and pijul push
+- [ ] pijul support on other commands
 
 
 # Support