diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 102 |
1 files changed, 37 insertions, 65 deletions
diff --git a/README.md b/README.md index 0833aa6..c23660e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Plain text with lines +# An editor for plain text. + +Not very useful by itself, but it's a fork of [lines.love](http://akkartik.name/lines.html) +that you can take in other directions besides line drawings, while easily +sharing patches between forks. -An editor for plain text where you can also seamlessly insert line drawings. Designed above all to be easy to modify and give you early warning if your modifications break something. -http://akkartik.name/lines.html - ## Getting started Install [LÖVE](https://love2d.org). It's just a 5MB download, open-source and @@ -17,13 +18,13 @@ optionally with a file path to edit. Alternatively, turn it into a .love file you can double-click on: ``` -$ zip -r /tmp/lines.love *.lua +$ zip -r /tmp/text.love *.lua ``` -By default, lines.love reads/writes the file `lines.txt` in +By default, it reads/writes the file `lines.txt` in [a directory relative to this app](https://love2d.org/wiki/love.filesystem.getSourceBaseDirectory). -To open a different file, drop it on the lines.love window. +To open a different file, drop it on the app window. ## Keyboard shortcuts @@ -35,12 +36,7 @@ While editing text: * `alt+right`/`alt+left` to jump to the next/previous word, respectively * mouse drag or `shift` + movement to select text, `ctrl+a` to select all -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. - -lines.love has been exclusively tested so far with a US keyboard layout. If +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 @@ -51,68 +47,44 @@ found anything amiss: http://akkartik.name/contact * No support yet for right-to-left languages. * Undo/redo may be sluggish in large files. Large files may grow sluggish in - other ways. lines.love works well in all circumstances with files under - 50KB. + other ways. 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. - -* 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. ## Mirrors and Forks -Updates to lines.love can be downloaded from the following mirrors in addition -to the website above: -* https://github.com/akkartik/lines.love -* https://repo.or.cz/lines.love.git -* https://tildegit.org/akkartik/lines.love -* https://git.tilde.institute/akkartik/lines.love -* https://git.sr.ht/~akkartik/lines.love -* https://notabug.org/akkartik/lines.love -* https://codeberg.org/akkartik/lines.love -* https://pagure.io/lines.love -* https://nest.pijul.com/akkartik/lines.love (using the Pijul version control system) - -Forks of lines.love are encouraged. If you show me your fork, I'll link to it -here. - -* https://github.com/akkartik/lines-polygon-experiment -- an experiment that - uses separate shortcuts for regular polygons. `ctrl+3` for triangles, - `ctrl+4` for squares, etc. -* https://git.sr.ht/~akkartik/text.love -- a stripped down version without - drawings; useful starting point for some forks -* https://git.sr.ht/~akkartik/pensieve.love -- a note-taking app on an - infinite 2D surface. Still in development. -* https://git.sr.ht/~akkartik/capture.love -- a blank-slate mode for the - note-taking app, so all the stuff pensieve.love puts on screen doesn't cause - you to forget what you came to write down. - -## Associated tools - -* https://codeberg.org/akkartik/lines2md exports lines.love files to Markdown - and (non-editable) SVG. -* https://git.sr.ht/~akkartik/lines2html.love exports lines.love files to html - and inline SVG. +This repo is a fork of [lines.love](http://akkartik.name/lines.html), an +editor for plain text where you can also seamlessly insert line drawings. +Updates to it can be downloaded from the following mirrors: + +* https://repo.or.cz/text.love.git +* https://tildegit.org/akkartik/text.love +* https://git.tilde.institute/akkartik/text.love +* https://git.sr.ht/~akkartik/text.love +* https://github.com/akkartik/text.love +* https://codeberg.org/akkartik/text.love +* https://notabug.org/akkartik/text.love +* https://pagure.io/text.love +* https://nest.pijul.com/akkartik/text.love (using the Pijul version control system) + +Further forks are encouraged. If you show me your fork, I'll link to it here. + +* https://git.sr.ht/~akkartik/view.love -- a stripped down version without + support for modifying files; useful starting point for some forks. +* https://git.sr.ht/~akkartik/pong.love -- a fairly minimal example app that + can edit and debug its own source code. +* https://git.sr.ht/~akkartik/template-live-editor -- a template for + building "free-wheeling" live programs (easy to fork, can be modified as + they run), with a text editor primitive. +* https://git.sr.ht/~akkartik/luaML.love -- a free-wheeling 'browser' for a + Lua-based markup language built as a live program. +* https://git.sr.ht/~akkartik/driver.love -- a programming environment for + modifying free-wheeling programs while they run. ## Feedback |