Mercurial Hosting > junotu
annotate README.md @ 90:3f068cb07fdf
TabCalendarBoard: Date selection fixes
Made 'end' of the range inclusive instead of exclusive, and now setting default spinners to midnight to avoid issues later.
| author | Fox |
|---|---|
| date | Sun, 19 Feb 2023 02:22:53 +0100 |
| parents | 0d4e996a5d99 |
| children |
| rev | line source |
|---|---|
| 26 | 1 # Description |
| 2 | |
| 3 Search through personal notes. | |
| 4 | |
| 5 I frequently run into problems finding that one specific video or article on the web, or a note I made sometime ago describing a fix to one particular problem that took a long time to research. What this program aims to do is allow you to throw all of that in quickly, and then be able to quickly search through every last bit of it. Cards are used to store information, each card has title, content and tags, with each tag optionally having a value. Then you are able to search through all your cards. | |
| 6 | |
| 7 ## Example usage | |
| 8 | |
| 9 You can add in all the movies, animation and series you have watched (or considering watching). Title of the card being used for the title, content for description, and tags for genres and your personal categories. For example, you can add tags like so: `genre:action genre:drama has:fights director:whateverson`. Then you can find all movies that are `genre:action` and not `genre:drama`, preferably containing word 'explosion' somewhere in the title or description. | |
| 10 | |
| 11 You can add link to a video you have watched, and write your own description for it, like `Parkour video about dude using parkour and freerun to go places. I think his name is Xin. Music playing is Give it All by Rise Against.` I would also add tags like `video:video hosting website 1`, so I could just search all cards that have the tag `video`, or specify that the video tag has to have the value `video hosting website 1`. | |
| 12 | |
| 13 ## In general | |
| 14 | |
|
80
0d4e996a5d99
Expanded generated 'readme.txt' and fixed minor mistake in 'README.md'
Fox
parents:
39
diff
changeset
|
15 The point is, adding something you want to find later, and thinking of a way to add 'hints' for when you will be searching for it later, so you can narrow the search down as much as possible. |
| 26 | 16 |
| 17 # Why create a new program? Alternatives? | |
| 18 | |
| 19 Everything I looked at wasn't good enough for me. The things I want: | |
| 20 - No need to register, works offline. | |
| 21 - A desktop application, preferably not using HTML. | |
| 22 - Able to handle throwing _everything_ at it. Thousands of cards, while still: | |
| 23 - Easily searchable and filterable. The basic 'find notes that contain search terms' doesn't cut it. Sometimes I only want to search through notes of a certain 'type' or a select few types. My 'tag' model solves that. | |
| 24 - Painless interface. | |
| 25 - Don't have useless animations that get in the way of using the program. | |
| 26 - Categorize, optimize. Avoid foot-long context menues, or unfrequent actions listed in always-visible top bar. | |
| 27 - Preferably pseudo-3 dimensional interface elements, not flat everything. I like to have shadowing and shading creating illusion of protruding objects, because it provides additonal hints of function. I notice buttons and section separation quicker. | |
| 28 | |
| 29 # Manual/Guide | |
| 30 | |
| 31 ## Search bar syntax | |
| 32 | |
| 33 You can just type words for searches to return matches in title and content. If you want to search tags you can use `tag:value` or `tag:*` syntax. For more, see this: https://lucene.apache.org/core/3_0_3/queryparsersyntax.html | |
| 34 | |
| 35 ## Backing up | |
| 36 | |
|
35
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
37 Not sure how well Lucene, and the way I use it, guards against corruption. So I recommend making backups of the `Database` folder from time to time. |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
38 |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
39 ## Compiling / Packaging |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
40 |
| 39 | 41 Scripts have the extension 'gui_sh' for my convenience, but they're just regular shell scripts. Use 'run.gui_sh' to run the program for development, and 'package.gui_sh' to compile it into a JAR and package everything into a TAR archive. The resulting program should be able to run on any operating system with Java available. |
|
35
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
42 |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
43 To run from source and package, you need: |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
44 - Java runtime and Java compiler. |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
45 - 'tar' command. |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
46 |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
47 To run packaged version you need: |
|
8cc09761cf18
Added 'Compiling / Packaging' section to the README file
Fox
parents:
26
diff
changeset
|
48 - Java runtime. |