README.md

Dev Mark

A command-line note-taking tool to mark important things throughout your day.

Commands

1. mark - Add a new mark
   • needs a date and time to add a mark
   • provide a date using --today, --today+{int}, --today-{int}
   • provide a time using --time=HH:MM or HH:MM:SS or HH-MM or HH-MM-SS
   • if no date or time is provided, a date must be entered using the date picker or time using the text field respectively.
2. marks - List all marks
   • needs a date to list marks for that date (same constraints as mark command)
3. unmark - Remove a mark
   • needs a date to list marks from which selection to delete needs to be made
   • one can multi-select marks to delete (same constraints as mark command)

Instructions to run locally

1. Clone the repo and install dependencies using cargo build
2. To initialize the database, download the setup.sql file from this repository
3. Then run the following command in your terminal:

   sqlite3 database.db < setup.sql

   This will create the necessary tables in the database
4. Be sure to update the name of the database in your .env file if you used something apart from database.db
5. Run the binary using cargo run <command> <args>