jale/README.md

62 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2021-02-15 22:13:12 +01:00
# Just Another Line Editor
or jale.nim
# Note
This is a new (and very immature) alternative to other
line editors such as linenoise (see rdstdin in the nim
standard library) or nimline (https://github.com/h3rald/nimline). Currently you probably want to use either of
those because this is a wip.
2021-02-21 00:52:11 +01:00
# Installation
2021-02-15 22:13:12 +01:00
```
2021-02-15 22:51:42 +01:00
git clone https://github.com/japl-lang/jale
cd jale
2021-02-21 00:52:11 +01:00
nimble install
```
# Checking the examples out
Building the examples
```
nimble examples
```
Checking the sample editor out. Quit with ctrl+c, save with ctrl+s.
```
examples/editor <filename>
# or windows:
.\examples\editor.exe <filename>
2021-02-15 22:13:12 +01:00
```
2021-02-21 00:52:11 +01:00
Checking the interactive prompt out. Move between lines using ctrl+up/down. Create new lines with ctrl+down on the last line. ctrl+page up/down also works.
```
examples/interactive_history
# or windows:
.\examples\interactive_history.exe
```
2021-02-15 22:13:12 +01:00
# Features
- multiline support
- easily add new keybindings (using templates)
- very customizable (even inserting characters is a keybinding that's optional)
2021-02-19 00:03:01 +01:00
- plugin system based
- history
2021-02-21 00:52:11 +01:00
- horizontal scrolling
2021-02-15 22:13:12 +01:00
# Missing features
Note: they won't be missing forever hopefully.
- No utf-8
2021-02-19 00:03:01 +01:00
- No tab autocompletion support
2021-02-15 22:13:12 +01:00
- No syntax highlighting support
2021-02-21 00:52:11 +01:00
- Windows output still really unstable/untested in depth
2021-02-15 22:13:12 +01:00