In-progress note-taking app based on lines.love
Go to file
Kartik K. Agaram d9fe8ccdd9 draft on-boarding notes for Drew DeVault 2022-08-11 09:33:05 -07:00
data.sample draft on-boarding notes for Drew DeVault 2022-08-11 09:33:05 -07:00
LICENSE.txt add a license 2022-05-16 18:51:28 -07:00
Manual_tests.md bugfix when editing a pane 2022-08-08 22:00:32 -07:00
MemoryReferenceInfo.lua.0 remove some memory leaks from rendered fragments 2022-06-10 11:16:41 -07:00
MemoryReferenceInfo.lua.unused clean up memory leak experiments 2022-06-10 13:46:59 -07:00
README.md draft on-boarding notes for Drew DeVault 2022-08-11 09:33:05 -07:00
app.lua hardcode some assumptions about how this app uses love 2022-08-06 09:35:42 -07:00
button.lua highlight another global 2022-05-17 23:24:46 -07:00
commands.lua disallow file switching in maximize mode 2022-08-10 22:26:30 -07:00
config.sample draft on-boarding notes for Drew DeVault 2022-08-11 09:33:05 -07:00
drawing.lua Merge upstream into main 2022-08-03 19:27:43 -07:00
drawing_tests.lua have file API operate on state object 2022-07-25 19:56:39 -07:00
edit.lua this would be the complete fix 2022-08-07 11:50:17 -07:00
file.lua always emit .json files in a consistent order 2022-08-05 07:23:46 -07:00
geom.lua stop pretending globals are local 2022-07-11 22:11:58 -07:00
help.lua bugfix: online help 2022-07-22 02:29:23 -07:00
icons.lua restore an icon 2022-07-29 12:26:47 -07:00
json.lua forgot to add json.lua 2022-05-15 14:36:25 -07:00
keychord.lua bugfix: typing a capital letter deletes selection 2022-06-26 17:07:27 -07:00
main.lua highlight currently selected command 2022-08-10 22:11:09 -07:00
main_tests.lua show top screen of multiple read-only panes 2022-07-16 15:30:38 -07:00
search.lua update cursor in search box 2022-07-25 18:17:04 -07:00
select.lua use line cache for drawings as well 2022-07-20 16:34:09 -07:00
test.lua selecting text and deleting selections 2022-05-29 08:12:47 -07:00
text.lua Merge upstream into main 2022-08-10 22:58:41 -07:00
text_tests.lua bugfix: pagedown was sometimes bouncing up 2022-08-10 22:56:10 -07:00
undo.lua line.y -> line_cache.starty in a few more places 2022-07-27 20:45:46 -07:00

README.md

In progress.

Invocation

To run pensieve.love, double-click on it. It can also be invoked from the terminal.

Side-effects: it reads/writes to a single directory tree. To import older notes, save them to the data subdirectory under the app's save directory (https://love2d.org/wiki/love.filesystem.getSaveDirectory).

Invocation

To try out pensieve.love with some sample data, run the following command from this repo's top-level directory:

love . sample

This will read the notes from the data.sample/ directory in the repo., and some initial settings from the config.sample file.

LÖVE limits what directories apps can access. The first run of the command above will write config.sample to the app's save directory, after which future runs will read/write it there. The notes will remain in this repo. To reset various settings back to defaults, delete the config.sample file in the app's save directory, and pensieve.love will again fall back to read it from this repo.

To create your own directory of notes, run without an argument (love .) In that case, pensieve.love will look for a data/ directory in the app's directory (this repo) or the save directory as above. If they don't exist, pensieve.love will create them in the save directory.

Keyboard shortcuts

While editing text:

  • ctrl+f to find patterns within a file
  • ctrl+c to copy, ctrl+x to cut, ctrl+v to paste
  • ctrl+z to undo, ctrl+y to redo
  • ctrl+= to zoom in, ctrl+- to zoom out, ctrl+0 to reset zoom
  • alt+right/alt+left to jump to the next/previous word, respectively

For shortcuts while editing drawings, consult the online help. Either:

  • hover on a drawing and hit ctrl+h, or
  • click on a drawing to start a stroke and then press and hold h to see your options at any point during a stroke.

pensieve.love has been exclusively tested so far with a US keyboard layout. If you use a different layout, please let me know if things worked, or if you found anything amiss: http://akkartik.name/contact

Known issues

  • No support yet for Unicode graphemes spanning multiple codepoints.

  • No support yet for right-to-left languages.

  • Undo/redo may be sluggish in large files. Large files may grow sluggish in other ways. pensieve.love works well in all circumstances with files under 50KB.

  • If you kill the process, say by force-quitting because things things get sluggish, you can lose data.

  • The text cursor will always stay on the screen. This can have some strange implications:

    • A long series of drawings will get silently skipped when you hit page-down, until a line of text can be showed on screen.
    • If there's no line of text at the top of the file, you may not be able to scroll back up to the top with page-up.

    So far this app isn't really designed for drawing-heavy files. For now I'm targeting mostly-text files with a few drawings mixed in.

  • No clipping yet for drawings. In particular, circles/squares/rectangles and point labels can overflow a drawing.

  • Long wrapping lines can't yet distinguish between the cursor at end of one screen line and start of the next, so clicking the mouse to position the cursor can very occasionally do the wrong thing.

  • Touchpads can drag the mouse pointer using a light touch or a heavy click. On Linux, drags using the light touch get interrupted when a key is pressed. You'll have to press down to drag.

  • Can't scroll while selecting text with mouse.

  • No scrollbars yet. That stuff is hard.

Feedback

Most appreciated.