chshersh/github-tui
1
1
Fork 0
mirror of https://github.com/chshersh/github-tui.git synced 2024-07-14 22:00:36 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
🌒 A TUI for GitHub
55 Commits 1 Branch 0 Tags 8.5 MiB
OCaml 99.8%
Standard ML 0.2%
2cba1ab3fb
Go to file
Dmitrii Kovanikov 2cba1ab3fb Add arrows to help
2024-06-23 15:44:32 +01:00
bin Format OCaml code 2024-03-23 10:26:12 +00:00
lib Add arrows to help 2024-06-23 15:44:32 +01:00
test Create OCaml project 2023-12-28 16:01:56 +00:00
.gitignore Create OCaml project 2023-12-28 16:01:56 +00:00
.ocamlformat Decrease FPS 2024-06-22 11:52:14 +01:00
dune-project Move chunks API into a separate module 2024-06-23 15:28:33 +01:00
github_tui.opam Move chunks API into a separate module 2024-06-23 15:28:33 +01:00
github_tui.opam.template WIP 2024-06-20 18:23:19 +01:00
LICENSE Initial commit 2023-12-26 12:42:16 +00:00
README.md Add scroller 2024-06-22 18:11:10 +01:00

README.md

github-tui

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 to support the development of this project.

Warning

github-tui is in alpha stage of development! Expect missing features and horrible bugs.

Prerequisites

To use github-tui, you need to have the following installed:

  1. OCaml toolchain: to build the project
  2. bat version ⩾ 0.19.0
  3. Hack Mono Nerd Font

Development

Initialise the project when building for the first time:

opam switch create .

Build the project:

dune build

Run the project:

dune exec bin/main.exe -- owner/repo

Install dev dependencies:

opam install utop ocamlformat ocaml-lsp-server