README.md

   1 # An editor for plain text.
   2
   3 [![0 dependencies!](https://0dependencies.dev/0dependencies.svg)](https://0dependencies.dev)
   4
   5 Not very useful by itself, but it's a fork of [lines.love](http://akkartik.name/lines.html)
   6 that you can take in other directions besides line drawings, while easily
   7 sharing patches between forks.
   8
   9 Designed above all to be easy to modify and give you early warning if your
  10 modifications break something.
  11
  12 ## Getting started
  13
  14 Install [LÖVE](https://love2d.org). It's just a 5MB download, open-source and
  15 extremely well-behaved.
  16
  17 To run from the terminal, [pass this directory to LÖVE](https://love2d.org/wiki/Getting_Started#Running_Games),
  18 optionally with a file path to edit.
  19
  20 Alternatively, turn it into a .love file you can double-click on:
  21 ```
  22 $ zip -r /tmp/text.love *.lua
  23 ```
  24
  25 By default, it reads/writes the file `lines.txt` in
  26 [a directory relative to this app](https://love2d.org/wiki/love.filesystem.getSourceBaseDirectory).
  27
  28 To open a different file, drop it on the app window.
  29
  30 ## Keyboard shortcuts
  31
  32 While editing text:
  33 * `ctrl+f` to find patterns within a file
  34 * `ctrl+c` to copy, `ctrl+x` to cut, `ctrl+v` to paste
  35 * `ctrl+z` to undo, `ctrl+y` to redo
  36 * `ctrl+=` to zoom in, `ctrl+-` to zoom out, `ctrl+0` to reset zoom
  37 * `alt+right`/`alt+left` to jump to the next/previous word, respectively
  38 * mouse drag or `shift` + movement to select text, `ctrl+a` to select all
  39 * `ctrl+e` to modify the sources
  40
  41 Exclusively tested so far with a US keyboard layout. If
  42 you use a different layout, please let me know if things worked, or if you
  43 found anything amiss: http://akkartik.name/contact
  44
  45 ## Known issues
  46
  47 * No support yet for Unicode graphemes spanning multiple codepoints.
  48
  49 * No support yet for right-to-left languages.
  50
  51 * Can't scroll while selecting text with mouse.
  52
  53 * No scrollbars yet. That stuff is hard.
  54
  55 ## Mirrors and Forks
  56
  57 This repo is a fork of [lines.love](http://akkartik.name/lines.html), an
  58 editor for plain text where you can also seamlessly insert line drawings.
  59 Updates to it can be downloaded from the following mirrors:
  60
  61 * https://repo.or.cz/text.love.git
  62 * https://tildegit.org/akkartik/text.love
  63 * https://git.tilde.institute/akkartik/text.love
  64 * https://git.merveilles.town/akkartik/text.love
  65 * https://git.sr.ht/~akkartik/text.love
  66 * https://github.com/akkartik/text.love
  67 * https://codeberg.org/akkartik/text.love
  68 * https://notabug.org/akkartik/text.love
  69 * https://pagure.io/text.love
  70 * https://nest.pijul.com/akkartik/text.love (using the Pijul version control system)
  71
  72 Further forks are encouraged. If you show me your fork, I'll link to it here.
  73
  74 * https://git.sr.ht/~akkartik/view.love -- a stripped down version without
  75   support for modifying files; useful starting point for some forks.
  76 * https://git.sr.ht/~akkartik/pong.love -- a fairly minimal example app that
  77   can edit and debug its own source code.
  78 * https://git.sr.ht/~akkartik/template-live-editor -- a template for
  79   building "free-wheeling" live programs (easy to fork, can be modified as
  80   they run), with a text editor primitive.
  81 * https://git.sr.ht/~akkartik/luaML.love -- a free-wheeling 'browser' for a
  82   Lua-based markup language built as a live program.
  83 * https://git.sr.ht/~akkartik/driver.love -- a programming environment for
  84   modifying free-wheeling programs while they run.
  85
  86 ## Feedback
  87
  88 [Most appreciated.](http://akkartik.name/contact) Messages, PRs, patches,
  89 forks, it's all good.