Radish alpha
r
radicle-tui
rad:z39mP9rQAaGmERfUMPULfPUi473tY
Radicle terminal user interface
Radicle
Git
Commits › 46c931c
chore: Improve README
Erik Kundt committed 3 months ago
commit 46c931c4d8f1681e91d9acbe2ce195fe9f3c28fc
parent 9375c38
1 file changed +42 -40
modified README.md
@@ -43,46 +43,6 @@ cargo install --force --locked --git https://seed.radicle.xyz/z39mP9rQAaGmERfUMP


This will install `rad-tui`. All available commands can be shown by running `rad-tui --help`.
- 
#### Nix
-
- 
There is a `flake.nix` present in the repository. This means that for
- 
development, it should be as simple as using [`direnv`](https://direnv.net/) and
- 
having the following `.envrc` file:
-
- 
```
- 
# .envrc
- 
use flake
- 
```
-
- 
For using the binary in a NixOS, in your `flake.nix` you can add one of the
- 
following to the `inputs` set:
-
- 
```nix
- 
inputs = {
- 
    # Replace <Tag> with the specific tag to build
- 
    radicle-tui = {
- 
        url = "git+https://seed.radicle.xyz/z39mP9rQAaGmERfUMPULfPUi473tY.git?tag=<Tag>";
- 
    }
- 
}
- 
```
-
- 
```nix
- 
inputs = {
- 
    # Replace <Commit SHA> with the specific commit to build
- 
    rad-tui = {
- 
        url = "git+https://seed.radicle.xyz/z39mP9rQAaGmERfUMPULfPUi473tY.git?rev=<Commit SHA>";
- 
    }
- 
}
- 
```
-
- 
Then in your `home.nix` you can add:
-
- 
```
- 
home.packages = [
- 
  inputs.radicle-tui.packages.${system}.default
- 
];
- 
```
- 


### Usage



This crate provides a binary called `rad-tui` which can be used as a drop-in replacement for `rad`. It maps known commands and operations to internal ones, running the corresponding app, e.g.
@@ -126,6 +86,48 @@ runs the patch list app and return a JSON object specifying the operation and id
{ "operation": "show", "ids": ["546443226b300484a97a2b2d7c7000af6e8169ba"], args:[] }

```
+ 
#### Other installation methods
+
+ 
##### Nix
+
+ 
There is a `flake.nix` present in the repository. This means that for
+ 
development, it should be as simple as using [`direnv`](https://direnv.net/) and
+ 
having the following `.envrc` file:
+
+ 
```
+ 
# .envrc
+ 
use flake
+ 
```
+
+ 
For using the binary in a NixOS, in your `flake.nix` you can add one of the
+ 
following to the `inputs` set:
+
+ 
```nix
+ 
inputs = {
+ 
    # Replace <Tag> with the specific tag to build
+ 
    radicle-tui = {
+ 
        url = "git+https://seed.radicle.xyz/z39mP9rQAaGmERfUMPULfPUi473tY.git?tag=<Tag>";
+ 
    }
+ 
}
+ 
```
+
+ 
```nix
+ 
inputs = {
+ 
    # Replace <Commit SHA> with the specific commit to build
+ 
    rad-tui = {
+ 
        url = "git+https://seed.radicle.xyz/z39mP9rQAaGmERfUMPULfPUi473tY.git?rev=<Commit SHA>";
+ 
    }
+ 
}
+ 
```
+
+ 
Then in your `home.nix` you can add:
+
+ 
```
+ 
home.packages = [
+ 
  inputs.radicle-tui.packages.${system}.default
+ 
];
+ 
```
+ 


## Build with `radicle-tui`



The library portion of this crate is a framework that is the foundation for all `radicle-tui` binaries. Although it evolved from the work on Radicle-specific applications and is far from being complete, it can serve as a general purpose framework to build applications on top already.