umcconnell / gram

Lightweight text editor in C in less than 1000 LoC. Adapted from antirez/kilo.

gram

Lightweight text editor in C in less than 1000 LoC.

Adapted from antirez/kilo with the Build Your Own Text Editor tutorial.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Getting started

Prerequisites

You will need a C compiler and GNU Make installed on your machine. On Windows, it's probably easiest to use WSL.

Installation

Clone the repository:

git clone https://github.com/umcconnell/gram
cd gram/

Then, use GNU Make to build:

make

Alternatively, you can download and install pre-built binaries for Linux under the Releases Tab.

If you are using the downloaded binary, you must not forget to first make it executable:

chmod a+x ./gram

Usage

Usage: gram [optional: filename]

Keys:

Ctrl-S:   Save
Ctrl-F:   Find
Ctrl-C/Q: Quit

Contributing

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ulysse McConnell - umcconnell

See also the list of contributors who participated in this project.

License

gram is distributed under the BSD 2-Clause License.

Acknowledgments

This project is adapted from antirez/kilo.

Huge shout-out goes to the awesome Build Your Own Text Editor tutorial.

The original kilo editor was slightly modified. Several languages and auto-indent were added.