Skip to content

Commit 93d8d4b

Browse files
committed
doc: Improve readme formatting, syntax highlighting, and headings
- Make "Download from" headings to be clearer and more consistent. - Specify `sh` in applicable code fences, for syntax highlighting. - Change code spans to code blocks (fences) in a couple places. - Tiny formatting adjustments, and slight rewording around a fence.
1 parent ca8d64c commit 93d8d4b

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

README.md

+18-10
Original file line numberDiff line numberDiff line change
@@ -177,17 +177,19 @@ on your needs, for _Linux_, _MacOS_ and _Windows_.
177177

178178
[releases]: https://github.com/GitoxideLabs/gitoxide/releases
179179

180-
### Download from Arch-Repository
180+
### Download from Arch Linux repository
181181

182182
For Arch Linux you can download `gitoxide` from `community` repository:
183-
```
183+
184+
```sh
184185
pacman -S gitoxide
185186
```
186187

187188
### Download from Exherbo Linux Rust repository
188189

189190
For Exherbo Linux you can download `gitoxide` from the [Rust](https://gitlab.exherbo.org/exherbo/rust/-/tree/master/packages/dev-scm/gitoxide) repository:
190-
```
191+
192+
```sh
191193
cave resolve -x repository/rust
192194
cave resolve -x gitoxide
193195
```
@@ -203,7 +205,7 @@ the latest stable one will work as well.
203205
There are various build configurations, all of them are [documented here](https://docs.rs/crate/gitoxide/latest). The documentation should also be useful
204206
for packagers who need to tune external dependencies.
205207

206-
```
208+
```sh
207209
# A way to install `gitoxide` with just Rust and a C compiler installed.
208210
# If there are problems with SSL certificates during clones, try to omit `--locked`.
209211
cargo install gitoxide --locked --no-default-features --features max-pure
@@ -220,19 +222,25 @@ cargo install gitoxide --locked --no-default-features --features lean
220222
The following installs the latest unpublished `max` release directly from git:
221223

222224
```sh
223-
cargo install --git https://github.com/GitoxideLabs/gitoxide gitoxide
225+
cargo install --git https://github.com/GitoxideLabs/gitoxide gitoxide
224226
```
225227

226228
#### How to deal with build failures
227229

228-
On some platforms, installation may fail due to lack of tools required by `C` toolchains. This can generally be avoided by installation
229-
with `cargo install gitoxide --no-default-features --features max-pure`.
230+
On some platforms, installation may fail due to lack of tools required by *C* toolchains. This can generally be avoided by installation with:
231+
232+
```sh
233+
cargo install gitoxide --no-default-features --features max-pure
234+
```
230235

231236
What follows is a list of known failures.
232237

233-
- On Fedora, `perl` needs to be installed for `OpenSSL` to build properly. This can be done with the following command:
234-
`dnf install perl` (see [this issue](https://github.com/GitoxideLabs/gitoxide/issues/592)).
235-
-
238+
- On Fedora, `perl` needs to be installed for `OpenSSL` to build properly. This can be done with the following command (see [issue #592](https://github.com/GitoxideLabs/gitoxide/issues/592)):
239+
240+
```sh
241+
dnf install perl
242+
```
243+
236244
### Using Docker
237245

238246
Some CI/CD pipelines leverage repository cloning. Below is a copy-paste-able example to build docker images for such workflows.

0 commit comments

Comments
 (0)