Lumus is a command-line tool written in Go that allows you to read PDF files directly in your terminal. It provides a minimalistic and distraction-free reading experience, making it ideal for reading documents in pdf format.
- Read PDF files directly in the terminal
- Navigate through pages easily
- Minimalistic and distraction-free interface
Before installing Lumus, you need to have the following dependencies installed on your system:
- Go (version 1.16 or later)
To install the default version available in the repositories:
sudo apt-get install tesseract-ocr libleptonica-dev libtesseract-dev poppler-utils wv unrtf tidy
Verify the Tesseract installation:
tesseract --version
If Tesseract is not version 5, add the PPA and update:
sudo add-apt-repository ppa:alex-p/tesseract-ocr5
sudo apt-get update
sudo apt-get install tesseract-ocr
sudo pacman -S tesseract poppler wv unrtf tidy leptonica
- Install on Arch
-
Clone this repository:
git clone https://github.com/Josehpequeno/lumus
-
Install base-devel:
sudo pacman -Syu base-devel
-
Navigate to the project directory:
cd lumus
-
Install with makepkg
makepkg -si
-
- Install on Debian/Ubuntu
- Download file lumus_1.0.1-1_amd64.deb on release
sudo dpkg -i lumus_1.0.1-1_amd64.deb && sudo apt-get install -f
- Download file lumus_1.0.1-1_amd64.deb on release
To use Lumus, simply run the executable and navigate to the file you want to read:
lumus
Once Lumus is running, you can navigate through pages using the arrow keys and perform various actions using the keyboard shortcuts displayed on the screen.
Contributions are welcome! If you find any bugs or have suggestions for new features, please open an issue or submit a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.
The development of a more thematic loading animation are in future plans, in addition to some future user recommendations.