p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Convert README to AsciiDoc

This commit is contained in:
Přemysl Eric Janouch 2015-09-27 01:26:24 +02:00
parent c03c56c740
commit 2a351b150d
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README → README.adoc
View File

@ -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 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) Optional dependencies: Unibilium (alternative for curses), GLib (for the demos)
$ git clone https://github.com/pjanouch/termo.git $ 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 $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
To install the library, you can do either the usual: To install the library, you can do either the usual:
# make install # make install
Or you can try telling CMake to make a package for you. For Debian it is: Or you can try telling CMake to make a package for you. For Debian it is:
$ cpack -G DEB $ cpack -G DEB
# dpkg -i termo-*.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 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. 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 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- libtool-based Makefile. Now you can include this project in your other
-based projects and simply import the target. No package maintainer action is CMake-based projects and simply import the target. No package maintainer action
needed for you to enjoy the benefits of proper terminal input. 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. 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 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 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
<leonerd@leonerd.org.uk>, with additional changes made by Přemysl Janouch <leonerd@leonerd.org.uk>, with additional changes made by Přemysl Janouch
<p.janouch@gmail.com>. <p.janouch@gmail.com>.