From 4f3dcb4888af9d6aff0e1274736e784f42e7bcc3 Mon Sep 17 00:00:00 2001 From: Aaron Fischer Date: Tue, 20 Oct 2020 11:13:45 +0200 Subject: [PATCH] Add some README --- src/Makefile => Makefile | 0 README.md | 15 ++++++++++++++- src/file.c => file.c | 0 src/file.h => file.h | 0 src/fn.c => fn.c | 0 src/fn.h => fn.h | 0 src/hl.c => hl.c | 0 src/hl.h => hl.h | 0 src/input.c => input.c | 0 src/input.h => input.h | 0 src/output.c => output.c | 0 src/output.h => output.h | 0 src/row.c => row.c | 0 src/row.h => row.h | 0 src/search.c => search.c | 0 src/search.h => search.h | 0 src/terminal.c => terminal.c | 0 src/terminal.h => terminal.h | 0 18 files changed, 14 insertions(+), 1 deletion(-) rename src/Makefile => Makefile (100%) rename src/file.c => file.c (100%) rename src/file.h => file.h (100%) rename src/fn.c => fn.c (100%) rename src/fn.h => fn.h (100%) rename src/hl.c => hl.c (100%) rename src/hl.h => hl.h (100%) rename src/input.c => input.c (100%) rename src/input.h => input.h (100%) rename src/output.c => output.c (100%) rename src/output.h => output.h (100%) rename src/row.c => row.c (100%) rename src/row.h => row.h (100%) rename src/search.c => search.c (100%) rename src/search.h => search.h (100%) rename src/terminal.c => terminal.c (100%) rename src/terminal.h => terminal.h (100%) diff --git a/src/Makefile b/Makefile similarity index 100% rename from src/Makefile rename to Makefile diff --git a/README.md b/README.md index eec9de7..d394551 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ This is a minimalistic, (mostly) POSIX complaint terminal text editor, which should be working on all common (and not so common) VT100 compatible terminal emulators. +This started as a little experiment, how far I can go with just a C +compiler and the linux mapnages, without any libs or other external +dependencies such as ncurses. This is a working text editor and +perfectly fine for quickly edit some config files or take some +notes, but definitive not intended to use as a full blown IDE. + ## Features * Load/Save/Create text files @@ -13,9 +19,16 @@ compatible terminal emulators. * Super small (23k) * No dependencies +## Limitations + +* No UTF-8. If you open an UTF-8 file with only characters from the ASCII + table (most of Englisch texts and source code), it works just fine + (because ASCII and UTF-8 are compatible in the "upper part" of the table), + but you will mess up your file when you are edit files with special + chars like รถ in it. + ## Compile - $ cd src $ make ## Run diff --git a/src/file.c b/file.c similarity index 100% rename from src/file.c rename to file.c diff --git a/src/file.h b/file.h similarity index 100% rename from src/file.h rename to file.h diff --git a/src/fn.c b/fn.c similarity index 100% rename from src/fn.c rename to fn.c diff --git a/src/fn.h b/fn.h similarity index 100% rename from src/fn.h rename to fn.h diff --git a/src/hl.c b/hl.c similarity index 100% rename from src/hl.c rename to hl.c diff --git a/src/hl.h b/hl.h similarity index 100% rename from src/hl.h rename to hl.h diff --git a/src/input.c b/input.c similarity index 100% rename from src/input.c rename to input.c diff --git a/src/input.h b/input.h similarity index 100% rename from src/input.h rename to input.h diff --git a/src/output.c b/output.c similarity index 100% rename from src/output.c rename to output.c diff --git a/src/output.h b/output.h similarity index 100% rename from src/output.h rename to output.h diff --git a/src/row.c b/row.c similarity index 100% rename from src/row.c rename to row.c diff --git a/src/row.h b/row.h similarity index 100% rename from src/row.h rename to row.h diff --git a/src/search.c b/search.c similarity index 100% rename from src/search.c rename to search.c diff --git a/src/search.h b/search.h similarity index 100% rename from src/search.h rename to search.h diff --git a/src/terminal.c b/terminal.c similarity index 100% rename from src/terminal.c rename to terminal.c diff --git a/src/terminal.h b/terminal.h similarity index 100% rename from src/terminal.h rename to terminal.h