d9fe8ccdd9 | ||
---|---|---|
data.sample | ||
LICENSE.txt | ||
Manual_tests.md | ||
MemoryReferenceInfo.lua.0 | ||
MemoryReferenceInfo.lua.unused | ||
README.md | ||
app.lua | ||
button.lua | ||
commands.lua | ||
config.sample | ||
drawing.lua | ||
drawing_tests.lua | ||
edit.lua | ||
file.lua | ||
geom.lua | ||
help.lua | ||
icons.lua | ||
json.lua | ||
keychord.lua | ||
main.lua | ||
main_tests.lua | ||
search.lua | ||
select.lua | ||
test.lua | ||
text.lua | ||
text_tests.lua | ||
undo.lua |
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 filectrl+c
to copy,ctrl+x
to cut,ctrl+v
to pastectrl+z
to undo,ctrl+y
to redoctrl+=
to zoom in,ctrl+-
to zoom out,ctrl+0
to reset zoomalt+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.