README.md

   1 # Plain text with lines
   2
   3 [![0 dependencies!](https://0dependencies.dev/0dependencies.svg)](https://0dependencies.dev)
   4
   5 An editor for plain text where you can also seamlessly insert line drawings.
   6 Designed above all to be easy to modify and give you early warning if your
   7 modifications break something.
   8
   9 http://akkartik.name/lines.html
  10
  11 ## Getting started
  12
  13 Install [LÖVE](https://love2d.org). It's just a 5MB download, open-source and
  14 extremely well-behaved.
  15
  16 To run from the terminal, [pass this directory to LÖVE](https://love2d.org/wiki/Getting_Started#Running_Games),
  17 optionally with a file path to edit.
  18
  19 Alternatively, turn it into a .love file you can double-click on:
  20 ```
  21 $ zip -r /tmp/lines.love *.lua
  22 ```
  23
  24 By default, lines.love reads/writes the file `lines.txt` in
  25 [a directory relative to this app](https://love2d.org/wiki/love.filesystem.getSourceBaseDirectory).
  26
  27 To open a different file, drop it on the lines.love window.
  28
  29 ## Keyboard shortcuts
  30
  31 While editing text:
  32 * `ctrl+f` to find patterns within a file
  33 * `ctrl+c` to copy, `ctrl+x` to cut, `ctrl+v` to paste
  34 * `ctrl+z` to undo, `ctrl+y` to redo
  35 * `ctrl+=` to zoom in, `ctrl+-` to zoom out, `ctrl+0` to reset zoom
  36 * `alt+right`/`alt+left` to jump to the next/previous word, respectively
  37 * mouse drag or `shift` + movement to select text, `ctrl+a` to select all
  38 * `ctrl+e` to modify the sources
  39
  40 For shortcuts while editing drawings, consult the online help. Either:
  41 * hover on a drawing and hit `ctrl+h`, or
  42 * click on a drawing to start a stroke and then press and hold `h` to see your
  43   options at any point during a stroke.
  44
  45 lines.love has been exclusively tested so far with a US keyboard layout. If
  46 you use a different layout, please let me know if things worked, or if you
  47 found anything amiss: http://akkartik.name/contact
  48
  49 ## Known issues
  50
  51 * No support yet for Unicode graphemes spanning multiple codepoints.
  52
  53 * No support yet for right-to-left languages.
  54
  55 * The text cursor will always stay on the screen. This can have some strange
  56   implications:
  57
  58     * A long series of drawings will get silently skipped when you hit
  59       page-down, until a line of text can be showed on screen.
  60     * If there's no line of text at the top of the file, you may not be able
  61       to scroll back up to the top with page-up.
  62
  63   So far this app isn't really designed for drawing-heavy files. For now I'm
  64   targeting mostly-text files with a few drawings mixed in.
  65
  66 * No clipping yet for drawings. In particular, circles/squares/rectangles and
  67   point labels can overflow a drawing.
  68
  69 * If you ever see a crash when clicking on the mouse, it might be because a
  70   mouse press and release need to happen in separate frames. Try pressing and
  71   releasing more slowly and let me know if that helps or not. This is klunky,
  72   sorry.
  73
  74 * Touchpads can drag the mouse pointer using a light touch or a heavy click.
  75   On Linux, drags using the light touch get interrupted when a key is pressed.
  76   You'll have to press down to drag.
  77
  78 * Can't scroll while selecting text with mouse.
  79
  80 * No scrollbars yet. That stuff is hard.
  81
  82 ## Mirrors and Forks
  83
  84 Updates to lines.love can be downloaded from the following mirrors in addition
  85 to the website above:
  86 * https://git.sr.ht/~akkartik/lines.love
  87 * https://repo.or.cz/lines.love.git
  88 * https://tildegit.org/akkartik/lines.love
  89 * https://git.merveilles.town/akkartik/lines.love
  90 * https://git.tilde.institute/akkartik/lines.love
  91 * https://codeberg.org/akkartik/lines.love
  92 * https://github.com/akkartik/lines.love
  93 * https://notabug.org/akkartik/lines.love
  94 * https://pagure.io/lines.love
  95 * https://nest.pijul.com/akkartik/lines.love (using the Pijul version control system)
  96
  97 Forks of lines.love are encouraged. If you show me your fork, I'll link to it
  98 here.
  99
 100 * https://github.com/akkartik/lines-polygon-experiment -- an experiment that
 101   uses separate shortcuts for regular polygons. `ctrl+3` for triangles,
 102   `ctrl+4` for squares, etc.
 103 * https://git.sr.ht/~akkartik/text.love -- a stripped down version without
 104   drawings; useful starting point for some forks
 105 * https://git.sr.ht/~akkartik/pensieve.love -- a note-taking app on an
 106   infinite 2D surface. Still in development.
 107 * https://git.sr.ht/~akkartik/capture.love -- a blank-slate mode for the
 108   note-taking app, so all the stuff pensieve.love puts on screen doesn't cause
 109   you to forget what you came to write down.
 110 * https://git.sr.ht/~akkartik/lines2.love -- an entirely new implementation of
 111   some foundations that seems more elegant.
 112
 113 ## Associated tools
 114
 115 * https://codeberg.org/akkartik/lines2md exports lines.love files to Markdown
 116   and (non-editable) SVG.
 117 * https://git.sr.ht/~akkartik/lines2html.love exports lines.love files to html
 118   and inline SVG.
 119 * https://codeberg.org/eril/lines2html.love provides the option to export
 120   just the drawings to a directory. Also provides a CLI, which should be more
 121   natural for many people.
 122
 123 ## Feedback
 124
 125 [Most appreciated.](http://akkartik.name/contact) Messages, PRs, patches,
 126 forks, it's all good.