From c2bc9e290ec92f65689bd4cf335b6c1934ac7d40 Mon Sep 17 00:00:00 2001 From: Aaron Fischer Date: Thu, 12 Nov 2020 11:51:13 +0100 Subject: [PATCH] Add a simple manpage and fix some typos --- .gitignore | 1 + Makefile | 11 +++++++++-- README.md | 8 ++++---- fn.6 | 20 ++++++++++++++++++++ 4 files changed, 34 insertions(+), 6 deletions(-) create mode 100644 fn.6 diff --git a/.gitignore b/.gitignore index 15a1b65..6db6d04 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ fn tags TAGS *.c~ +fn.6.gz diff --git a/Makefile b/Makefile index 5e138e0..791aa79 100644 --- a/Makefile +++ b/Makefile @@ -16,6 +16,13 @@ SRC=$(wildcard *.c) fn: $(SRC) $(CC) -o $@ $^ $(CFLAGS) -clean: - rm -f fn +man: fn.6 + cat fn.6 | gzip - > fn.6.gz +man-test: fn.6.gz + groff -man -Tascii fn.6 + +all: fn man + +clean: + rm -f fn{,.6.gz} diff --git a/README.md b/README.md index 033ed97..be7cc2c 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # fuNote -This is a minimalistic, (mostly) POSIX complaint terminal text editor, +This is a minimalistic, (almost) 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 +compiler and the Linux manpages, 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 +perfectly fine for quickly edit some configuration files or take some notes, but definitive not intended to use as a full blown IDE. ## Features @@ -16,7 +16,7 @@ notes, but definitive not intended to use as a full blown IDE. * Common keyboard controls * Search * Syntax Highlighting for C (so you can edit fuNote source IN fuNote) -* Super small (23k) +* Super small (23k binary) * No dependencies ## Limitations diff --git a/fn.6 b/fn.6 new file mode 100644 index 0000000..bb02ac5 --- /dev/null +++ b/fn.6 @@ -0,0 +1,20 @@ +.TH fn 6 "November 2020" "" "version 0.2" +.SH NAME +fn - a simple and super small text editor +.SH SYNOPSIS +.B fn +[filename] +.SH DESCRIPTION +.B fn +aim not to be a very good editor. It was a learning experiment, which ended +up in a super compact text editor, which can be used to edit configuration +files and C source code with syntax highlightung. This project was inspired +by Salvatore Sanfilippos "kilo". +.SH BUGS +The editor is not jet suitable to edit UTF-8 reliable. So keep that in mind +if you want to write non english texts. +.SH AUTHOR AND LINKS +The project is created by Aaron Fischer . +.RE +.I https://aaron-fischer.net/abc +.RS