iREADME.md - gramscii - A simple editor for ASCII box-and-arrow charts Err bitreich.org 70 1Log /scm/gramscii/log.gph bitreich.org 70 1Files /scm/gramscii/files.gph bitreich.org 70 1Refs /scm/gramscii/refs.gph bitreich.org 70 1Tags /scm/gramscii/tag bitreich.org 70 1README /scm/gramscii/file/README.md.gph bitreich.org 70 1LICENSE /scm/gramscii/file/COPYING.gph bitreich.org 70 i--- Err bitreich.org 70 iREADME.md (3485B) Err bitreich.org 70 i--- Err bitreich.org 70 i 1 gramscii -- interactive tool for ASCII box-and-arrows charts Err bitreich.org 70 i 2 ============================================================ Err bitreich.org 70 i 3 Err bitreich.org 70 i 4 `gramscii` (pronounced "grrr'a(m)sky", more or less like "ASCII" but Err bitreich.org 70 i 5 with a leading "grrr") is a simple CLI tool to create and edit Err bitreich.org 70 i 6 box-and-arrows charts using ASCII characters. Err bitreich.org 70 i 7 Err bitreich.org 70 i 8 `gramscii` is interactive and its commands are quite intuitive to Err bitreich.org 70 i 9 anybody who does not need a mouse to be productive. You can move around Err bitreich.org 70 i 10 the screen with the usual `hjkl` keys, but you will travel at Err bitreich.org 70 i 11 ligthning speed by placing one of your other fingers on `SHIFT`. You Err bitreich.org 70 i 12 start drawing a box with `b`, and you place an arrow with `a`. Err bitreich.org 70 i 13 For more information, just read the manpage. Err bitreich.org 70 i 14 Err bitreich.org 70 i 15 `gramscii` aims at remaining small, avoiding bloat, and being Err bitreich.org 70 i 16 portable. It is written in ASCII C90, it requires only an ANSI Err bitreich.org 70 i 17 VT100-compatible terminal (real or virtual), and it does not use any Err bitreich.org 70 i 18 external library (nope, not even ncurses!). Hence, you should be able to Err bitreich.org 70 i 19 compile and run `gramscii` on any operating system with a C90 libc Err bitreich.org 70 i 20 and a VT100 terminal emulator. Err bitreich.org 70 i 21 Err bitreich.org 70 i 22 I have tested it on Linux and BSD, compiled with `gcc`, Err bitreich.org 70 i 23 `clang`, and `tcc`, and linked it against `glibc`, Err bitreich.org 70 i 24 `musl`, and whatever libc was available on FreeBSD, OpenBSD, and Err bitreich.org 70 i 25 NetBSD. It just worked. Err bitreich.org 70 i 26 Err bitreich.org 70 i 27 INSTALL Err bitreich.org 70 i 28 ======= Err bitreich.org 70 i 29 Err bitreich.org 70 i 30 Edit `config.h` and/or `config.mk` to suit your preferences. Err bitreich.org 70 i 31 Then just: Err bitreich.org 70 i 32 Err bitreich.org 70 i 33 make Err bitreich.org 70 i 34 Err bitreich.org 70 i 35 to build `gramsci` and: Err bitreich.org 70 i 36 Err bitreich.org 70 i 37 ./gramscii Err bitreich.org 70 i 38 Err bitreich.org 70 i 39 to execute it. `man` is your friend. Err bitreich.org 70 i 40 Err bitreich.org 70 i 41 Err bitreich.org 70 i 42 WHY? Err bitreich.org 70 i 43 ==== Err bitreich.org 70 i 44 Err bitreich.org 70 i 45 As most of the software out there, `gramscii` comes out of Err bitreich.org 70 i 46 frustration and pain. Err bitreich.org 70 i 47 Err bitreich.org 70 i 48 I have been producing box-and-arrow diagrams in ASCII for quite a while. Err bitreich.org 70 i 49 I know that there exist ad-hoc plugins for `vim(1)` and Err bitreich.org 70 i 50 `emacs(1)`, but I was not happy with any of them, to say the least. Err bitreich.org 70 i 51 There are also a few point-and-click GUI tools to do the same, but most Err bitreich.org 70 i 52 of them depend on a variety of libraries/modules. And again, why would Err bitreich.org 70 i 53 you need a fancy GUI to create ASCII charts? Err bitreich.org 70 i 54 Err bitreich.org 70 i 55 There has been a recent proliferation of browser-based point-and-click Err bitreich.org 70 i 56 tools to draw ASCII charts. Like, are you serious? Why on Earth should Err bitreich.org 70 i 57 people accept to load hundred thousands LOCs of obscure javascript code Err bitreich.org 70 i 58 on a hyper-bloated web browser and use a fancy point-and-click interface Err bitreich.org 70 i 59 to produce......guess what......ASCII charts that are best-viewed viewed Err bitreich.org 70 i 60 on a VT100 terminal? Err bitreich.org 70 i 61 Err bitreich.org 70 i 62 We must say no to madness. We must repudiate bloat. We must reject Err bitreich.org 70 i 63 useless featurism. Software must be reasonable, simple, small, and Err bitreich.org 70 i 64 functional. Err bitreich.org 70 i 65 Err bitreich.org 70 i 66 But wait... Err bitreich.org 70 i 67 ============ Err bitreich.org 70 i 68 Err bitreich.org 70 i 69 You might have noticed that the name `gramscii` is reminiscent of Err bitreich.org 70 i 70 Antonio Gramsci, the phylosopher and politician who was among the Err bitreich.org 70 i 71 founders of the Italian Communist Party in 1921. Now, Gramscii (the Err bitreich.org 70 i 72 philosopher) strongly believed that every single human is an Err bitreich.org 70 i 73 intellectual, a philosopher, and an artist, and maintained that societal Err bitreich.org 70 i 74 changes are only possible when a class exerts intellectual and moral Err bitreich.org 70 i 75 leadership over its contemporaries. So just get rid of all your shiny Err bitreich.org 70 i 76 iPointless things and come back to reality. Err bitreich.org 70 i 77 Err bitreich.org 70 i 78 COPYING Err bitreich.org 70 i 79 ======= Err bitreich.org 70 i 80 Err bitreich.org 70 i 81 `gramscii` is written and maintained by Vincenzo 'KatolaZ' Nicosia Err bitreich.org 70 i 82 . You can use, modify and/or redistribute it under Err bitreich.org 70 i 83 the terms of the GNU General Public Licence, either version 3 of the Err bitreich.org 70 i 84 License or, at your option, any later version. Err bitreich.org 70 i 85 Err bitreich.org 70 i 86 This program is distributed in the hope that it will be useful, but Err bitreich.org 70 i 87 WITHOUT ANY WARRANTY; without even the implied warranty of Err bitreich.org 70 i 88 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Err bitreich.org 70 i 89 General Public License for more details. Err bitreich.org 70 .