Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.5 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.5 KB
Raw

Chaffinch

Build codecov

Chaffinch is a text editor written in Elixir using the Ratatouille toolkit. At the moment, the project is basically a learning exercise for me to get comfortable with Elixir. I do not in any way claim that this code is idiomatic or well thought out, but I hope it might become so.

How to run it

Install elixir, clone this repository, and build a release:

mix deps.get
mix compile
mix release

At the moment, you have to set the file to be opened though an environment variable. You can start the application with a file opened like this:

CHAFFINCH_FILE=./welcome.txt _build/dev/rel/chaffinch/bin/chaffinch start

Roadmap

  • Basic text editing in frame
  • Status and message bars
    • Basic control shortcuts
    • File name and status at the top
  • Handle text dimensions exceeding the window size
    • X/Y scrolling
    • Scrollbars
  • File I/O
    • Loading a file with command line arguments through an environment variable
    • Saving the current state
    • Prompt when trying to close in a dirty state
  • More advanced controls, user configurations
  • Improved design
  • Menus/tabs ?
  • Syntax highlighting