Add a simple manpage and fix some typos
This commit is contained in:
parent
3349c8bf14
commit
c2bc9e290e
4 changed files with 34 additions and 6 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
@ -5,3 +5,4 @@ fn
|
||||||
tags
|
tags
|
||||||
TAGS
|
TAGS
|
||||||
*.c~
|
*.c~
|
||||||
|
fn.6.gz
|
||||||
|
|
11
Makefile
11
Makefile
|
@ -16,6 +16,13 @@ SRC=$(wildcard *.c)
|
||||||
fn: $(SRC)
|
fn: $(SRC)
|
||||||
$(CC) -o $@ $^ $(CFLAGS)
|
$(CC) -o $@ $^ $(CFLAGS)
|
||||||
|
|
||||||
clean:
|
man: fn.6
|
||||||
rm -f fn
|
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}
|
||||||
|
|
|
@ -1,13 +1,13 @@
|
||||||
# fuNote
|
# 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
|
which should be working on all common (and not so common) VT100
|
||||||
compatible terminal emulators.
|
compatible terminal emulators.
|
||||||
|
|
||||||
This started as a little experiment, how far I can go with just a C
|
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
|
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.
|
notes, but definitive not intended to use as a full blown IDE.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
@ -16,7 +16,7 @@ notes, but definitive not intended to use as a full blown IDE.
|
||||||
* Common keyboard controls
|
* Common keyboard controls
|
||||||
* Search
|
* Search
|
||||||
* Syntax Highlighting for C (so you can edit fuNote source IN fuNote)
|
* Syntax Highlighting for C (so you can edit fuNote source IN fuNote)
|
||||||
* Super small (23k)
|
* Super small (23k binary)
|
||||||
* No dependencies
|
* No dependencies
|
||||||
|
|
||||||
## Limitations
|
## Limitations
|
||||||
|
|
20
fn.6
Normal file
20
fn.6
Normal file
|
@ -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 <mail@aaron-fischer.net>.
|
||||||
|
.RE
|
||||||
|
.I https://aaron-fischer.net/abc
|
||||||
|
.RS
|
Loading…
Reference in a new issue