summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 842517e5b9358d66f86cf51f80be2f2186569c70 (plain)
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
<h3 align="center">Starship ✨🚀</h3>
<p align="center">The cross-shell prompt for astronauts.</p>

---

This is very much work in progress, so please don't try to use it just yet!

## Setup

### Prerequisites

- Rust v1.33 or higher
- Fisher v3

### Getting Started

1. `cd` to the root of the **starship** repo
1. Install the **starship** binary:

    ```bash
    cargo install --path .
    ```

1. Install the fish shell prompt with fisher:

    ```bash
    fisher $PWD
    ```