From 2a351b150dbe133037afffef01375c39aacd9d74 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 27 Sep 2015 01:26:24 +0200 Subject: [PATCH] Convert README to AsciiDoc --- README => README.adoc | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) rename README => README.adoc (89%) diff --git a/README b/README.adoc similarity index 89% rename from README rename to README.adoc index 6bd1979..ce63059 100644 --- a/README +++ b/README.adoc @@ -14,7 +14,7 @@ The API isn't stable yet. Tell me what needs to be done so I can fix it first. Building and Installing ----------------------- -Build dependencies: cmake >= 2.8.5, pkg-config +Build dependencies: cmake >= 2.8.5, pkg-config + Optional dependencies: Unibilium (alternative for curses), GLib (for the demos) $ git clone https://github.com/pjanouch/termo.git @@ -23,9 +23,11 @@ Optional dependencies: Unibilium (alternative for curses), GLib (for the demos) $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug To install the library, you can do either the usual: + # make install Or you can try telling CMake to make a package for you. For Debian it is: + $ cpack -G DEB # dpkg -i termo-*.deb @@ -44,12 +46,12 @@ http://gnu.org/software/libunistring/manual/libunistring.html#The-wchar_005ft-me To make the mouse parsing support actually useful, some API has been added to set the proper modes on request, and unset them appropriately while destroying. -You can have a look at demo-draw.c for an example. +You can have a look at 'demo-draw.c' for an example. Another change worth mentioning is the usage of CMake instead of the problematic -libtool-based Makefile. Now you can include this project in your other CMake- --based projects and simply import the target. No package maintainer action is -needed for you to enjoy the benefits of proper terminal input. +libtool-based Makefile. Now you can include this project in your other +CMake-based projects and simply import the target. No package maintainer action +is needed for you to enjoy the benefits of proper terminal input. The rest is just me going silly over formatting and various unimportant stuff. Oh, and I've deleted the manpages. It needs more Doxygen. :) TBD @@ -62,7 +64,7 @@ the developer, feel free to join me at irc://anathema.irc.so, channel #anathema. License ------- -`termo' is based on the `termkey' library, originally written by Paul Evans +'termo' is based on the 'termkey' library, originally written by Paul Evans , with additional changes made by Přemysl Janouch .