cargo-sync-rdme 0.8.0

Cargo subcommand to synchronize README with crate documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Installation

There are multiple ways to install `cargo-sync-rdme`.
Choose any one of the methods below that best suits your needs.

## Prebuilt Binaries

Executable binaries are published on the [GitHub Release page].
Download the appropriate archive for your platform (Windows, macOS, Linux) and architecture (x86_64, aarch64) and extract the archive.
The archive contains the `cargo-sync-rdme` executable.

To run `cargo-sync-rdme` as a Cargo subcommand, place the `cargo-sync-rdme` executable in a directory on your `PATH`.

If you use [`cargo-binstall`], you can install `cargo-sync-rdme` with the following command:

```console
cargo binstall cargo-sync-rdme
```

[GitHub Release page]: https://github.com/gifnksm/cargo-sync-rdme/releases/
[`cargo-binstall`]: https://github.com/cargo-bins/cargo-binstall

## Install from Source

To install `cargo-sync-rdme` from source, the Rust toolchain must be installed on your system.
See [the Rust installation guide] if you do not have Rust installed yet.

Then install either the latest released version or the current development version from the Git repository.

```console
cargo install cargo-sync-rdme
```

```console
cargo install --git https://github.com/gifnksm/cargo-sync-rdme.git cargo-sync-rdme
```

[the Rust installation guide]: https://www.rust-lang.org/tools/install

## Arch User Repository (AUR)

If you are using an Arch Linux-based distribution, you can install `cargo-sync-rdme` from the AUR.
The packages are maintained by the developer of `cargo-sync-rdme` and are updated with each release.

There are two packages available in the AUR:

* [`cargo-sync-rdme-bin`]: package that installs prebuilt binaries
* [`cargo-sync-rdme`]: package that builds from source

[`cargo-sync-rdme-bin`]: https://aur.archlinux.org/packages/cargo-sync-rdme-bin
[`cargo-sync-rdme`]: https://aur.archlinux.org/packages/cargo-sync-rdme

## Verify the Installation

Run:

```console
$ cargo sync-rdme --version
cargo sync-rdme <version>
```

If the command succeeds, `cargo-sync-rdme` is installed and available on your `PATH`.