bujoshell

A bullet journal app for the terminal.

How to Use • Dependencies • How to Install • Preferences • To-do • Contribute • License

🚀 How to Use

To use, simply type it in the terminal:

$ bujoshell

⚓ Dependencies

It only needs gcc or tcc to compile, ncurses as the graphic library, SQLite to manage the databases and pkg-config to proper library's linking.

Note: you'll need a Nerd Font patched font for the icons.

ARCH LINUX
$ sudo pacman -S base-devel ncurses sqlite3 pkgconf

UBUNTU
$ sudo apt install build-essential libncurses5-dev libncursesw5-dev sqlite3 pkg-config

FEDORA
$ sudo dnf groupinstall 'Development Tools' && sudo dnf install ncurses-devel sqlite sqlite-devel sqlite-tcl pkgconf

MACOS
$ brew install gcc sqlite ncurses

💾 How to Install

To install you just need to copy and paste this 3 commands in the terminal:

$ git clone https://github.com/gabrielzschmitz/bujoshell.git
$ cd bujoshell
$ sudo make install

Note: a good practice is to clone the repo at $HOME/.local/src/

Note: first install all the dependencies!

🔧 Preferences

To change the default configurations, edit the config.h, then sudo make install to take effect. You can change those configs:

• ICONS: iconsoff - iconson - nerdicons;
• MIN_WIDTH: 1 - ∞;
• MIN_HEIGTH: 1 - ∞;

📝 To-do

• Implement migranting and scheduling entrys
• Implement a template system
• Implement mouse support
• Make a welcome screen
• Implement a colorscheme system

🤝 Contribute

Feel free to contribute to the project!

📜 License

This software is licensed under the GPL-3 license.