rafaelwi / rnote

RNote - A simple, compiled document format intended for taking bullet-point notes.

RNote Compiled Document Format

RNote is a simple, compiled document format intended for taking bullet-point notes.

Features

• Easy to learn and use syntax designed for taking notes quickly
• Customizable document themes and templates
• Seventeen different page sizes to choose from
• Bold, underline, italicize, and strikethrough your text
• Insert images and tables with ease
• Simple command-line interface for generating your documents quickly

Setup

1. Clone the repo
   git clone https://github.com/rafaelwi/rnote
2. CD into the rnote directory and create a new pipenv
   pipenv install
   This will install the necessary libraries for RNote to work
3. Open up your favourite text editor and begin writing documents. Take a look at the format spec sheet to learn the syntax.
   
4. When you're done writing your document, simply enter the rnote directory and run the processor to generate your document into a PDF
   ./rnote -i INPUT_FILE.rnote -o OUTPUT_FILE.pdf

NOTE: If RNote does not run, please run chmod +x rnote and try again.

Contgratulations! If all has gone well, you have successfully created your first RNote document!