Skip to content

Commit

Permalink
Installation section README
Browse files Browse the repository at this point in the history
  • Loading branch information
density215 committed Dec 21, 2023
1 parent f2459a1 commit 6a85471
Showing 1 changed file with 52 additions and 3 deletions.
55 changes: 52 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,68 @@ will be free, open-source software.
> You should also be aware that all the APIs, configuration and the `roto`
> syntax and grammar are still (highly) unstable.
>
### INSTALLATION

There is no packaged, versioned release of `Rotonda` yet. You can install from
the main branch if you have a Rust toolchain installed.

First, you'll need some general build tools, to be able to download and
install `Rust`. On the command line issue this command, while making sure you
have enough privileges on the system to perform these actions:

```bash
apt install curl build-essential gcc make
```

This is for Debian based systems, on other distributions and/or operating
systems you will have to install these tools as well.

On most based systems you can then install `Rust` by issuing:

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

and then finally you can build Rotonda directly from github:

```bash
cargo install rotonda --git https://github.com/NLnetLabs/rotonda
```

If you restart you shell, you can start Rotonda by simply typing:

```bash
rotonda
```

Note that rotonda will probably tell you it can't find its filters. Read the
documentation for more information about this. Also not that rotonda needs a
`Rust` version `1.71` or higher, which means that if you are using a Rust version
packaged by your distribution, that Rust version may be outdated.

Releases on `crates.io`, the online `Rust` library collection, and a proper
versioned release with `.deb` and `.rpm` packages is under way. If the above
installation method does not work for you, we advise you to wait for this
release.

### ROADMAP

Rotonda is under heavy development and should be considered **alpha** software. See the [roadmap](ROADMAP.md) in this repository for more details.
`Rotonda` is under heavy development and should be considered **alpha**
software. See the [roadmap](ROADMAP.md) in this repository for more details.

### DOCUMENTATION

The documentation does not necessarily reflect the reality of Rotonda at this stage. Features that appear in the documentation might only be partly implemented — or not at all. Likewise, implemented features may be undocumented. Before we make an official release we will clearly mark the status of all features in the documentation.
The documentation does not necessarily reflect the reality of `Rotonda` at this
stage. Features that appear in the documentation might only be partly
implemented — or not at all. Likewise, implemented features may be
undocumented. Before we make an official release we will clearly mark the
status of all features in the documentation.

Read the PRELIMINARY documentation [here](https://rotonda.docs.nlnetlabs.nl/).

### LICENSE

The rotonda crate is distributed under the terms of the MPL-2.0 license. See [LICENSE](https://github.com/NLnetLabs/rotonda/blob/main/LICENSE) for details
The rotonda crate is distributed under the terms of the MPL-2.0 license. See
[LICENSE](https://github.com/NLnetLabs/rotonda/blob/main/LICENSE) for details

Rotonda is and always will be free, open-source software.

0 comments on commit 6a85471

Please sign in to comment.