chshersh/github-tui
1
1
Fork 0
mirror of https://github.com/chshersh/github-tui.git synced 2024-07-07 06:46:23 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
github-tui/README.md
Oren Mittman 51de590db6
Update README.md (#10) 
Fix typo
2024-06-28 08:37:44 +01:00

1.1 KiB
Raw Permalink Blame History

github-tui

A TUI interface to GitHub.

Warning

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

Completion: Done 26%/100% 🌕🌕🌗🌑🌑🌑🌑🌑🌑🌑

Important

DISCLAIMER: github-tui 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.

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