~cezelot/eve

A terminal-based text editor

19cc0d0 feat: highlight keywords

~cezelot pushed to ~cezelot/eve git

2 months ago

3cce365 style(output): change the right edge of the status bar

~cezelot pushed to ~cezelot/eve git

2 months ago

#eve

builds.sr.ht status

A simple command-line text editor.

eve is a lightweight, user-friendly text editor for the terminal that aims to be simple and intuitive, while also taking advantage of the capabilities of advanced text editors.

The project is in alpha stage and will provides essential and powerful editing features (see Roadmap), making it ideal for editing configuration files, creating scripts or witing source codes from the command-line.

#Getting Started

#Prerequisites

  • A Unix-like operating system: GNU/Linux, BSD, macOS, etc. On Windows, you can use WSL2 or Cygwin. On Android, use Termux.
  • Tools for building the executable:
    • make
    • gcc

You can install all the required tools on Linux (Debian-based) with this command:

sudo apt install make gcc

#Compiling

If you haven't already clone the repository:

git clone https://git.sr.ht/~cezelot/eve

Navigate to the repo directory and run make:

cd eve
make

It'll build an executable named eve.

#Make rules
Command Description
make Compile eve.
make clean Remove objects files.
make fclean Remove objects files and eve.
make re Re-compile eve.

#Installation

To install eve, copy the executable into ~/.local/bin:

cp eve ~/.local/bin

Or into /usr/local/bin, note that you must have adequate privileges:

sudo cp eve /usr/local/bin

#Usage

To open and edit a file:

eve <filename>

To create a new file:

eve

Then use Ctrl-S to create and save the new file.

#Roadmap

List of features planned for version 1.0.0:

  • [x] Text viewer
  • [x] Text editor
  • [x] Search feature
  • [ ] Syntax highlighting and filetype detection
  • [ ] Line number
  • [ ] Config file
  • [ ] Text formatting
    • [ ] Soft indent
    • [ ] Auto indent
    • [ ] Hard-wrap lines
    • [ ] Soft-wrap lines
  • [ ] Cut, Copy and paste
  • [ ] Modal editing
  • [ ] Undo/Redo

#Contributing

Send patches/bug reports to ~cezelot/eve-devel@lists.sr.ht.

#Authors

#License

eve is free software distributed under the GNU Public License, for details see COPYING.

#Aknowledgments

Thanks to Paige Ruten for her excellent tutorial.