Skip to content

Commit

Permalink
update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rvhonorato committed Sep 20, 2024
1 parent 146dad5 commit a29f3b8
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions docs/src/installation.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,35 @@
# Installation

`haddock-restraints` is a Rust command-line tool. To install it, you need to have the Rust toolchain installed on your system. You can install Rust by following the instructions on the [official website](https://www.rust-lang.org/tools/install).
`haddock-restraints` is a Rust command-line tool. You can either download the pre-compiled binary, download from the Rust package manager or build it from source.

It is also published in [Crates.io](https://crates.io/crates/haddock-restraints), so you can install it using the following command using Cargo, the Rust package manager:
## Download

Get a pre-compiled binary for your system at the link below:

<div style="">
<style>
.feedback-button {
display: inline-block;
padding: 10px 20px;
background-color: #337ab7;
color: white !important;
text-decoration: none;
border-radius: 5px;
font-weight: bold;
transition: background-color 0.3s ease;
}
.feedback-button:hover {
background-color: #23527c;
}
</style>

<a href="https://github.com/haddocking/haddock-restraints/releases/tag/v0.5.0" class="feedback-button" target="_blank">Download</a>

</div>

## Build from Cargo

To install the tool using Cargo, you need to have the Rust toolchain installed on your system. You can install Rust by following the instructions on the [official website](https://www.rust-lang.org/tools/install).

```bash
cargo install haddock-restraints
Expand All @@ -24,6 +51,6 @@ cd haddock-restraints
cargo build --release
```

***
---

Go ahead and proceed to the [USAGE](./usage.md) section to learn how to use the tool.

0 comments on commit a29f3b8

Please sign in to comment.