raket 0.1.2

A simple bash prompt.
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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

<p align="center">
    <img src="media/logo.png" alt="raket" width="200"/>
</p>
  
<p align="center">
  <em>A simple bash prompt.</em>
</p>
  
<p align="center">
        <img src="https://img.shields.io/crates/v/raket?style=flat-square&color=blueviolet&link=https%3A%2F%2Fcrates.io%2Fcrates%raket" alt="Crates.io version" />
    <img src="https://img.shields.io/badge/license-MIT-green?style=flat-square" alt="MIT License" />
    <img src="https://img.shields.io/github/last-commit/simon-danielsson/raket/main?style=flat-square&color=blue" alt="Last commit" />
</p>
  
<p align="center">
  <a href="#feat">Features</a> •
  <a href="#install">Install</a> •
  <a href="#config">Config</a> •
  <a href="#deps">Dependencies</a> •
  <a href="#license">License</a>
</p>  
  
---
<div id="feat"></div>

## Features
  
- For designing your folder structures Raket features its own scripting language with support for custom variables, striking a balance between flexibility and ease-of-use. [Neovim plugin for syntax highlighting and such is available here](https://github.com/simon-danielsson/raket.nvim).
- Subcommands for normalizing, correcting and sorting raw audio stems in record-time (not implemented yet).
  
---
<div id="install"></div>

## Install
  
Install binary using cargo:
  
``` bash
cargo install raket
```
  
Add the following line to your .bashrc:
  
``` bash
PROMPT_COMMAND='PS1="$(raket)"'
```
  
---
<div id="config"></div>

## Config
  
Launch Raket for the first time to generate a default config file:  
`~/.config/raket/config`  
  
``` conf
icons [
    prompt = ""
]

colors [
    main = "#aab3c0"
    git_branch = "#9ec1a3"
    git_branch_paren = "#aab3c0"
]

settings [
    # add space in between each command
    space = true

    # if true, the prompt input will be below. if false, on the same line
    prompt_newline = true
]
```
  
---
<div id="deps"></div>
  
## Dependencies
  
+ [raster](https://github.com/kosinix/raster)  
+ [regex](https://github.com/rust-lang/regex)  
  
---
<div id="license"></div>

## License
  
This project is licensed under the [MIT License](https://github.com/simon-danielsson/raket/blob/main/LICENSE).