Capymanga is a terminal UI for reading manga from Mangadex. It is written in OCaml and uses kitty to show images in your terminal.
Capymanga is currently under construction and is missing many features!
I'd like to eventually make installing Capymanga really easy. While Capymanga is being built, you can use it by building it from source. If these instructions do not work, please feel free to let me know by filing an issue!
-
If you haven't already, install kitty. Kitty is a terminal emulator that lets Capymanga show images from the terminal. I would like to implement first-class support for other terminal emulators at some point in the future, though sadly Capymanga currently can only display images with kitty...
-
If you are new to OCaml - or if you haven't already - install opam. It is OCaml's package manager and we'll be using it to install Capymanga's OCaml dependencies. The specific install instructions depend on your platform; you can find platform-specific instructions here.
-
Create a new "opam switch". You can think of a switch as kind of like a "python environment". A more detailed explanation of "switches" is here. I've developed capymanga on OCaml 5.1.0, so we'll be creating switch for OCaml 5.1.0.
opam switch create 5.1.0- Clone this repo, and go inside of it with
cd:
git clone https://github.com/Enoumy/capy
cd capy- Install capymanga's dependencies:
opam install . --deps-only --with-test- Build capymanga with dune.
duneis OCaml's "build system". We'll use dune to turn our source code into an executable we can run. It should have been installed in the previous step for you. You can useduneto build capymanga with:
dune build- Assuming that the above step succeeded,
dunewill place the things it builds inside of a_build/defaultdirectory. You should be able to run capymanga with:
./_build/default/app/capymanga/bin/main.exe- For convenience, rather than typing the long path each time, you can also run
make runto run capymanga.