/lightwrite

Little text editor made with SDL2 in C.

Primary LanguageCMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License


lightwrite

Little text editor written in C using SDL2.
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Using
  4. Contributing
  5. License

About The Project

This is a really simple GUI-based text editor, which is based on the dramatic editor ded, developed by tsoding, a twitch streamer known for recreational programming. As of right now, lightwrite is using his approach of handling file-content. Even though the code for managing files is not exactly the same, lightwrite will at least use the same datastructures.

  • Written in plain C.
  • lightweight (as the name implies)

(back to top)

Getting Started

Packaging status

If you only want to use lightwrite and not mess with it's source, go ahead an grab one of the avalible releases (preferably the latest).

prepare the release folder (VERSION stands for the version you've downloaded)

tar -xf lightwrite-VERSION.tar.gz && cd lightwrite-VERSION

building

./configure && make

installing

sudo make install

Messing with the source

Here you can see how to setup this project locally. Since this project is mainly developed in Linux, Windows build is not yet supported.

Prerequisites

  • git, autotools, make, gcc
  • sdl2, sdl2_ttf

Installation

clone the repo and move inside

git clone git@github.com:tim-tm/lightwrite.git && cd breakout

setting up the project

./autogen.sh

building

make -C build

or

cd build && make

Cleanup

./cleanup.sh

(back to top)

Using

Lightwrite is not a vim-like editor (even though I personally prefer such editors).

Keybind Action
Ctrl+S Save the current buffer
Ctrl+Shift+f Open the filemanager
Ctrl+a Create a new file (only in the filemanager)
Up/Down/Left/Right Navigating up/down/left/right

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information. SDL2 and SDL2_ttf are both distributed under the zlib license.

(back to top)