Skip to content

Commit

Permalink
feat: adding previal doc
Browse files Browse the repository at this point in the history
  • Loading branch information
BrunoCiccarino committed Jan 28, 2025
1 parent 1947700 commit 2d3cd44
Showing 1 changed file with 58 additions and 1 deletion.
59 changes: 58 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,62 @@

- A Nerd Font or Powerline Font installed and enabled in your terminal (for example, try the FiraCode Nerd Font).

<!-- ## 💤 Installation -->
## 💤 Installation

To install it is very simple, just put the binary in the path. And then after that you need to follow these steps depending on the shell you are using.

<details>
<summary>Bash</summary>
in your .bashrc add

```shell
PS1='$(astroship)'
```
</details>

<details>
<summary>Zsh</summary>
in your .zshrc add

```shell
PROMPT='$(astroship)'
```
</details>

<details>
<summary>Nushell</summary>
in your config.nu add

```shell
prompt = $(astroship)
```
</details>

<details>
<summary>Fish</summary>
in your config.fish add

```shell
function fish_prompt
astroship
end
```
</details>

<details>
<summary>Powershell</summary>
in your $PROFILE add

```shell
function prompt {
& astroship
}
```
</details>

## 💭 Inspired By

- [starship](https://github.com/starship/starship)
- [spaceship](https://github.com/spaceship-prompt/spaceship-prompt)
- [robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)

0 comments on commit 2d3cd44

Please sign in to comment.