Skip to content

Commit

Permalink
doc: improved website getting started and installation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
fujiapple852 committed Dec 23, 2024
1 parent 9cc99fa commit f01b1b9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
13 changes: 8 additions & 5 deletions docs/src/content/docs/start/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@ The following steps will guide you through the process of installing and running

1. Install Trippy:

```shell
cargo install trippy --locked
```
Trippy runs on Linux, BSD, macOS, and Windows. It can be installed from most common package managers, precompiled binaries, or source.

For example, to install Trippy from `cargo`:

See the [installation guide](/start/installation/) for details of how to install Trippy on your system.
```shell
cargo install trippy --locked
```

See the [installation guide](/start/installation/) for details of how to install Trippy on your system.

2. Run Trippy:

To run an `ICMP` trace to `example.com`, use the following command:
To run a basic trace to `example.com` with default settings, run the following command:

```shell
sudo trip example.com
Expand Down
7 changes: 5 additions & 2 deletions docs/src/content/docs/start/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ sidebar:
order: 2
---

Trippy can be installed on a variety of platforms using a variety of package managers. The following sections provide instructions for installing Trippy on your platform.
The following sections provide instructions for installing Trippy on your platform.

Trippy runs on Linux, BSD, macOS, and Windows. It can be installed from most common package managers, precompiled
binaries, or source.

## Distributions

Expand Down Expand Up @@ -43,7 +46,7 @@ apt update && apt install trippy
:::note
Only available for Ubuntu 24.04 (`Noble`) and 22.04 (`Jammy`).
:::

### Snap (Linux)

[![trippy](https://snapcraft.io/trippy/badge.svg)](https://snapcraft.io/trippy)
Expand Down

0 comments on commit f01b1b9

Please sign in to comment.