Liszt

Liszt makes it easy to jot down thoughts in the command line, and keep ideas clear in separate notes.

View Liszt documentation here

Installation
Usage
- Commands
- Example
Contributing to the Project
Community Information

Installation

Please note that at the moment, Liszt is only tested on macOS, but it will build on linux.

Please also note that v1.1.8 does change some existing functionality that will cause incompatibility with the existing Liszt file system on your computer. If you already have Liszt installed, before updating to v1.1.8, please go to your ~/.liszt directory and rename the directory called 'notes' to 'main'.

Homebrew

In your terminal

$ brew tap liszt-music/liszt
$ brew install lst

These commands will install the tap of Liszt on your system and then install the executable 'lst' in /usr/local/bin.

Git Clone

In your terminal

$ git clone https://github.com/scamacho23/liszt.git
$ cd liszt 
$ cmake .
$ make
$ make install

Liszt relies on cmake for compilation and linking so we recommend having cmake installed on your system. Alternatively, the following should do the trick (we use clang but any c compiler should work):

$ git clone https://github.com/scamacho23/liszt.git
$ cd liszt 
$ clang src/main.c -o lst -g
$ ln -s lst /usr/local/bin/lst

Pkg Installer

Click on this to be redirected to the local liszt-1.1.8.pkg file. Click 'download' on the right side of the page to download the package installer.

Any issues with installation should be emailed to liszt.central@gmail.com

Usage

Commands

Please note that all functions listed below require lst before the command.

Command	Function
`-a <note title>`	Add a new note
`-r <memory index>`	Remove memory at specified index
`<memory content>`	Add a new memory in current note
`-ch`	Change to a different note
`-rn`	Rename note
`-rm`	Remove note
`-ar`	Archive note
`-unar`	Unarchive note
`-in`	Import note
`-ex`	Export note
`-dp`	Duplicate note
`-mg`	Merge notes
`-c`	Copy memory
`-h <function handle>`	Get help for a specific function

Example

Add a note and a few memories

$ lst -a school
Added new note 'school'
$ lst Complete assignment one
Remembered 'Complete assignment one'
$ lst Study for quiz
Remembered 'Study for quiz'

Add another note and memories

$ lst -a work
Added new note 'work'
$ lst Check emails
Remembered 'Check emails'
$ lst Complete code review
Remembered 'Complete code review'
$ lst Submit PTO request
Remembered 'Submit PTO request'

Review memories on the current note

$ lst -l
Found 3 memories on 'work'
1. Check emails
2. Complete code review
3. Submit PTO request

Remove a memory by line number, i.e. complete a task

$ lst -r 2
Removed memory 'Complete code review'
$ lst -l
Found 2 memories on 'work'
1. Check emails
2. Submit PTO request
$ lst -r 1
Removed memory 'Check emails'
$ lst -l
Found 1 memories on 'work'
1. Submit PTO request

List all notes and change to a specified note

$ lst -ln
Found 2 notes
1. work
2. school
$ lst -ch school
Changed current note to 'school'

List memories on this note and remove one after completion

$ lst -l
Found 2 memories on 'school'
1. Complete assignment one
2. Study for quiz
$ lst -r 1
Removed memory 'Complete assignment one'
$ lst -l
Found 1 memories on 'school'
1. Study for quiz

Contributing to the Project

For more information, see the CONTRIBUTING.md file. This project is fully open-source. We appreciate all the help we can get and are very open to beginners and anyone interested in helping.

Community Information

There is a Slack channel for contributors. If you would like to join the channel, make a pull request and include in the comment that you would like to be added (and the email to be used for the invite).

scamacho23/liszt