Code Monkey home page Code Monkey logo

bujoshell's Introduction


bujoshell icon
bujoshell

A bullet journal app for the terminal.

License Buy Me A Coffee Give me a Star

How to UseDependenciesHow to InstallPreferencesTo-doContributeLicense

🚀 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.

bujoshell's People

Contributors

gabrielzschmitz avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.