haddock-restraints 0.11.1

Generate restraints to be used in HADDOCK
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

# Installation

`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.

## Download

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

<div style="">
  <style>
    .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;
    }
    .button:hover {
      background-color: #23527c;
    }
  </style>

<a href="https://github.com/haddocking/haddock-restraints/releases/latest" class="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
```

Now it should be available in your system. You can check if it is installed by running:

```bash
haddock-restraints -h
```

## From source

If you prefer to install it from source, you can clone the repository and build it using Cargo:

```bash
git clone https://github.com/haddocking/haddock-restraints
cd haddock-restraints
cargo build --release
```

---

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