2023-12-26 15:42:16 +03:00
|
|
|
# github-tui
|
2024-03-23 13:07:04 +03:00
|
|
|
|
2024-06-22 15:22:54 +03:00
|
|
|
A TUI interface to GitHub.
|
|
|
|
|
|
|
|
|
|
> [!IMPORTANT]
|
|
|
|
|
> **DISCLAIMER:** `github-ui` is developed and maintained in free time
|
|
|
|
|
> voluntarily. The development may continue for decades or may stop tomorrow. You
|
|
|
|
|
> can use
|
|
|
|
|
> [GitHub Sponsorship](https://github.com/sponsors/chshersh) to support
|
|
|
|
|
> the development of this project.
|
|
|
|
|
|
|
|
|
|
> [!WARNING]
|
|
|
|
|
> `github-tui` is in _alpha_ stage of development!
|
|
|
|
|
> Expect missing features and horrible bugs.
|
2024-03-23 13:07:04 +03:00
|
|
|
|
2024-06-22 20:11:10 +03:00
|
|
|
## Prerequisites
|
|
|
|
|
|
|
|
|
|
To use `github-tui`, you need to have the following installed:
|
|
|
|
|
|
|
|
|
|
1. OCaml toolchain: to build the project
|
|
|
|
|
1. `bat` version ⩾ 0.19.0
|
|
|
|
|
1. [Hack Mono Nerd Font](https://www.nerdfonts.com/)
|
|
|
|
|
|
2024-03-23 13:07:04 +03:00
|
|
|
## Development
|
|
|
|
|
|
2024-06-22 15:22:54 +03:00
|
|
|
Initialise the project when building for the first time:
|
2024-03-23 13:07:04 +03:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
opam switch create .
|
|
|
|
|
```
|
|
|
|
|
|
2024-06-22 15:22:54 +03:00
|
|
|
Build the project:
|
2024-03-23 13:07:04 +03:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
dune build
|
|
|
|
|
```
|
|
|
|
|
|
2024-06-22 15:22:54 +03:00
|
|
|
Run the project:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
dune exec bin/main.exe -- owner/repo
|
|
|
|
|
```
|
|
|
|
|
|
2024-03-23 13:07:04 +03:00
|
|
|
Install dev dependencies:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
opam install utop ocamlformat ocaml-lsp-server
|
|
|
|
|
```
|
