replace in README.md - gramscii - A simple editor for ASCII box-and-arrow char… | |
Log | |
Files | |
Refs | |
Tags | |
README | |
LICENSE | |
--- | |
commit 11bc65417241ce068ebd65ef4670d7d3e7c9ae8d | |
parent 00b84065d6b6b216df2c65eaa49dd6f2cd5725b5 | |
Author: KatolaZ <[email protected]> | |
Date: Wed, 24 Jul 2019 13:06:03 +0100 | |
replace in README.md | |
Diffstat: | |
M README.md | 34 ++++++++++++++++-------------… | |
1 file changed, 17 insertions(+), 17 deletions(-) | |
--- | |
diff --git a/README.md b/README.md | |
@@ -1,54 +1,54 @@ | |
gramscii -- interactive tool for ASCII box-and-arrows charts | |
============================================================ | |
-```gramscii``` (pronounced "grrr'a(m)sky", more or less like "ASCII" but | |
+`gramscii` (pronounced "grrr'a(m)sky", more or less like "ASCII" but | |
with a leading "grrr") is a simple CLI tool to create and edit | |
box-and-arrows charts using ASCII characters. | |
-```gramscii``` is interactive and its commands are quite intuitive to | |
+`gramscii` is interactive and its commands are quite intuitive to | |
anybody who does not need a mouse to be productive. You can move around | |
-the screen with the usual ```hjkl``` keys, but you will travel at | |
-ligthning speed by placing one of your other fingers on ```SHIFT```. You | |
-start drawing a box with ```b```, and you place an arrow with ```a```. | |
+the screen with the usual `hjkl` keys, but you will travel at | |
+ligthning speed by placing one of your other fingers on `SHIFT`. You | |
+start drawing a box with `b`, and you place an arrow with `a`. | |
For more information, just read the manpage. | |
-```gramscii``` aims at remaining small, avoiding bloat, and being | |
+`gramscii` aims at remaining small, avoiding bloat, and being | |
portable. It is written in ASCII C90, it requires only an ANSI | |
VT100-compatible terminal (real or virtual), and it does not use any | |
external library (nope, not even ncurses!). Hence, you should be able to | |
-compile and run ```gramscii``` on any operating system with a C90 libc | |
+compile and run `gramscii` on any operating system with a C90 libc | |
and a VT100 terminal emulator. | |
-I have tested it on Linux and *BSD, compiled with ```gcc```, | |
-```clang```, and ```tcc```, and linked it against ```glibc```, | |
-```musl```, and whatever libc was available on FreeBSD, OpenBSD, and | |
+I have tested it on Linux and *BSD, compiled with `gcc`, | |
+`clang`, and `tcc`, and linked it against `glibc`, | |
+`musl`, and whatever libc was available on FreeBSD, OpenBSD, and | |
NetBSD. It just worked. | |
INSTALL | |
======= | |
-Edit ```config.h``` and/or ```config.mk``` to suit your preferences. | |
+Edit `config.h` and/or `config.mk` to suit your preferences. | |
Then just: | |
``` | |
make | |
``` | |
-to build ```gramsci``` and: | |
+to build `gramsci` and: | |
``` | |
./gramscii | |
``` | |
-to execute it. ```man``` is your friend. | |
+to execute it. `man` is your friend. | |
WHY? | |
==== | |
-As most of the software out there, ```gramscii``` comes out of | |
+As most of the software out there, `gramscii` comes out of | |
frustration and pain. | |
I have been producing box-and-arrow diagrams in ASCII for quite a while. | |
-I know that there exist ad-hoc plugins for ```vim(1)``` and | |
-```emacs(1)```, but I was not happy with any of them, to say the least. | |
+I know that there exist ad-hoc plugins for `vim(1)` and | |
+`emacs(1)`, but I was not happy with any of them, to say the least. | |
There are also a few point-and-click GUI tools to do the same, but most | |
of them depend on a variety of libraries/modules. And again, why would | |
you need a fancy GUI to create ASCII charts? | |
@@ -67,7 +67,7 @@ functional. | |
But wait... | |
============ | |
-You might have noticed that the name ```gramscii``` is reminiscent of | |
+You might have noticed that the name `gramscii` is reminiscent of | |
Antonio Gramsci, the phylosopher and politician who was among the | |
founders of the Italian Communist Party in 1921. Now, Gramscii (the | |
philosopher) strongly believed that every single human is an |