From fd9c94dfd92e387c184a318dc1c18e7098268045 Mon Sep 17 00:00:00 2001 From: FujiApple Date: Mon, 23 Dec 2024 21:13:30 +0800 Subject: [PATCH] doc: improved website getting started and installation pages --- docs/src/content/docs/start/getting-started.mdx | 13 ++++++++----- docs/src/content/docs/start/installation.md | 7 +++++-- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/src/content/docs/start/getting-started.mdx b/docs/src/content/docs/start/getting-started.mdx index 4fd697b6..dbedbd28 100644 --- a/docs/src/content/docs/start/getting-started.mdx +++ b/docs/src/content/docs/start/getting-started.mdx @@ -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 diff --git a/docs/src/content/docs/start/installation.md b/docs/src/content/docs/start/installation.md index 327b5e27..b7666d9e 100644 --- a/docs/src/content/docs/start/installation.md +++ b/docs/src/content/docs/start/installation.md @@ -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 @@ -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)