This is a simple note taking application. One can take, edit, and remove notes using it, notes can be tagged and filtered by tag. For more see specification. The application has a graphical as well as a command-line interface. The command line interface and the graphical interface are synchronised. In other words they modify the same global state. Terminating either of the active user interfaces will terminate the entire process. The program takes the following options
| prefix | function |
|---|---|
| -f | the subsequent string is taken as the default file location, the application will attempt to read from the file at launch, and unless changed will write to it when saving the notes. |
| -u | if the subsequent string is "gui" only the graphical user interface will be launched, in case it is "cmd" it launches the command-line interface without the graphical interface, in case the following string is anything else the application terminates immediately |
Any invalid arguments given to the application are ignored.
The notes are stored in an edn file, for more on the format see edn-format. Be aware that the application does not write the notes to a file on exit, saving is performed only when the user explicitly does so.
To run the application simply download the jar file associated with the latest release, and run the command
java -jar <otm-note jar file> <options>
For more explicit instructions see manual.
To use the development tools you will need to have clojure installed. See GettingStarted for instructions on installing and getting started. For more information on the command line tools see Deps and CLI guide. For a brief overview of the code structure see architecture. Note also that while this project makes very light use of specs they document the implicit data model, and the tests rely on them being up to date.
clj -A:main
this command takes the same command line options as the program, for details see the Use section of this document or the Manual.
Using cambada
clj -A:uberjar
The files are found in the target directory.
The standalone can be run using the command
java -jar target/otm-notes-1.0.0-SNAPSHOT-standalone.jar "filename"
Here again using an actual filename.
A repl enhanced by rebel-readline.
clj -A:repl
Check the project using clj-kondo
clj -A:style
Run the test suite using kaocha
clj -A:test
Using cloverage
clj -A:cov
Fixed the ones I found…
For the timelog of the project timelog. Pertaining to the tests tests
- Export option: csv
- Style the GUI