bobrossrtx / kilo

A nano like a terminal text editor

Kilo

A nano like a terminal text editor

Setup

Building from source

To build a kilo from the source, you can either build through a unix type operating system, or you can build kilo through WSL, Cygwin, Docker, or even Windows bash if you are running on Microsoft Windows 10.

First off, make is a necessary tool to know when working and building C/C++ code, it is so usefull and is what will be used in this application for building. So if you want, you can install make to build the binaries for the project. With make, you can set up functions that execute commands that are made to make building C/C++ Projects easier. To install make on Debian-based Linux distributions, you can run sudo apt install make.

You should be able to compile straight from there, but just in case, you might need to install GNU/gcc, which is a C Runtime compile that allows the user to compiler C into binary executables. To install, it is as simple as typing sudo apt install gcc into your terminal.

An alternative to make is just building from the command line, if you needed to install gcc, you will be able to install straight from the command line. I recommend that if there is already a kilo executable, just to remove that binary so it does not get in the way of the build process. but, with the gcc command, you can run cc src/kilo.c -o kilo -Wall -Wextra -pedantic -std=c99 and that will compile straight into binaries that can be used

From then on, you can easily install Kilo. If you are using make, you can build the application by executing the command make all into your terminal and it will remove any already existing binaries, and replace them with the updated ones.

Use

Docker

If you would like to use a docker container, you can pull the docker image that is hosted at hub.docker.com. You can modify the source code, use the tool and even build upon what is already there. To pull a docker image, you need to use the cli tool that they have created that you can download at the Getting Started page. If you have the CLI tool, you can now pull the image. The command that is used to pull the image down is docker push owenboreham/kilo:latest. Fair warning, if you are not experienced with docker, I would recommend at least following their getting started guide to get you familiar with how to use it. Once you have the image, you can build a container by executing the command docker run -i -t owenboreham/kilo bash. This will launch you into a ubuntu terminal that you can then execute unix commands. You are then free to play, work, and use this program inside of that container.

Under Construction

kilo's Issues

Fix 'Complex Method' issue in src\kilo.c

Issue: Complex Method

The editorReadKey() method is really long and can be hard to maintain and understand.

It's currently on:
src\kilo.c:105-153
Commit 9bb7756