Giter VIP home page Giter VIP logo

book-mode's Introduction

book-mode

A flexible tool for keeping track of what you read, when you read, how you read, all while being a hand-writable text format.

book-mode is a CLI. It might at some point also be an emacs mode, depending on how passionately I feel about that (PRs welcome ๐Ÿ˜ฌ)

Building

book-mode is written in Rust and can be built with cargo.

$ cargo build --release

Spec

book-mode fundamentally only parses text files. These can either be written by you, the user, or at a later point also the CLI. Each .books file contains several sections that use indentation to differentiate between keys and values in a very simple way. Headers use special indentation that's obviously distinguishable from entries. Here's an example.

Some Title 					2017
    Genre: Science Fiction
    ISBN: 1234-56789-123
    Pages: 420
  
Another Title					2017-2018
    Genre: Political fiction
    ISBN: 4321-98765-321
    Pages: 666

As you can see book-mode can also take into account that some books will be started in one year and finished in another. When generating graphs, books that span multiple years will be counted as 3/4 for both years, to make the graphs look as natural as possible. For raw numbers, it counts as 1 for both years because a book was indeed read, just not finished in time.

License

book-mode is free software, licensed under the "GPL-3" or later.

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.