summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2019-04-13 00:33:50 -0400
committerMatan Kushner <hello@matchai.me>2019-04-13 00:34:56 -0400
commit4ce4899f81de37ab6e9916981c628ea057e429a7 (patch)
tree9b6488ca6266e700729526012f27d2cc006fdb08
parent240fb6a02cec721b1ca0d874b7e930b177e7adc3 (diff)
Add fish_prompt
-rw-r--r--README.md24
-rw-r--r--fish_prompt.fish3
-rw-r--r--src/main.rs2
-rw-r--r--src/segment.rs2
4 files changed, 28 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4dba8a84f..842517e5b 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,28 @@
<h3 align="center">Starship ✨🚀</h3>
-<p align="center">The cross-platform prompt for astronauts.</p>
+<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
+ ```
diff --git a/fish_prompt.fish b/fish_prompt.fish
new file mode 100644
index 000000000..965398ea1
--- /dev/null
+++ b/fish_prompt.fish
@@ -0,0 +1,3 @@
+function fish_prompt
+ starship $status
+end
diff --git a/src/main.rs b/src/main.rs
index f8bc4bcd4..dfd328135 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -13,7 +13,7 @@ use clap::{App, Arg};
fn main() {
let args = App::new("Starship")
- .about("The cross-platform prompt for astronauts. ✨🚀")
+ .about("The cross-shell prompt for astronauts. ✨🚀")
// pull the version number from Cargo.toml
.version(crate_version!())
// pull the authors from Cargo.toml
diff --git a/src/segment.rs b/src/segment.rs
index 99f3c0a92..a9a188f62 100644
--- a/src/segment.rs
+++ b/src/segment.rs
@@ -42,7 +42,7 @@ impl Segment {
}
/// Sets the style of the segment
- ///
+ ///
/// Accepts either `Color` or `Style`.
pub fn set_style<T>(&mut self, style: T) -> &mut Segment
where