p
/
tdv
1
1
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:44:06 +02:00
parent 533ea1044a
commit 4c30a62246
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README → README.adoc
View File

@ -1,7 +1,7 @@
StarDict Terminal UI StarDict Terminal UI
==================== ====================
`sdtui' aims to provide an easy way of viewing translation as well as other 'sdtui' aims to provide an easy way of viewing translation as well as other
kinds of dictionaries in your terminal. I wasn't successful in finding any free kinds of dictionaries in your terminal. I wasn't successful in finding any free
dictionary software of this kind, GUI or not, and thus decided to write my own. dictionary software of this kind, GUI or not, and thus decided to write my own.
@ -16,6 +16,7 @@ be done yet before the software can be considered fit for inclusion in regular
Linux and/or BSD distributions. Help is much appreciated. Linux and/or BSD distributions. Help is much appreciated.
An approximate list of things that need to be resolved: An approximate list of things that need to be resolved:
- rewrite the frontend using a proper TUI framework - rewrite the frontend using a proper TUI framework
- load a list of installed dictionaries at startup (use the default locations - load a list of installed dictionaries at startup (use the default locations
used by StarDict) and let the user choose which dictionary to open used by StarDict) and let the user choose which dictionary to open
@ -23,7 +24,7 @@ An approximate list of things that need to be resolved:
Building and Running Building and Running
-------------------- --------------------
Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl +
Runtime dependencies: ncursesw, zlib, ICU, termo (included), Runtime dependencies: ncursesw, zlib, ICU, termo (included),
glib-2.0, pango, gtk+ (optional, any version) glib-2.0, pango, gtk+ (optional, any version)
@ -34,25 +35,27 @@ Runtime dependencies: ncursesw, zlib, ICU, termo (included),
$ make $ make
To install the application, you can do either the usual: To install the application, 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 sdtui-*.deb # dpkg -i sdtui-*.deb
Note that for versions of CMake before 2.8.9, you need to prefix cpack with Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with
`fakeroot' or file ownership will end up wrong. `fakeroot` or file ownership will end up wrong.
Having the program installed, simply run it with a StarDict .ifo file as an Having the program installed, simply run it with a StarDict '.ifo' file as an
argument. If you want the application to watch the X11 primary selection for argument. If you want the application to watch the X11 primary selection for
changes and automatically search for the selected text, use the -w switch. changes and automatically search for the selected text, use the `-w` switch.
This feature requires GTK+. This feature requires GTK+.
Extensions Extensions
---------- ----------
As the original StarDict is a bit of a clusterfuck with regard to collation of As the original StarDict is a bit of a clusterfuck with regard to collation of
dictionary entries, I had to introduce an additional "collation" field into the dictionary entries, I had to introduce an additional `collation` field into the
.ifo file. When sdtui discovers this field while reading the dictionary, it '.ifo' file. When sdtui discovers this field while reading the dictionary, it
automatically reorders the index according to that locale (e.g. "cs_CZ"). automatically reorders the index according to that locale (e.g. "cs_CZ").
This operation may take a little while. This operation may take a little while.
@ -61,8 +64,8 @@ Dictionaries
Unfortunately this application only really works with specific dictionaries. Unfortunately this application only really works with specific dictionaries.
Word definitions have to be in plain text, separated by newlines. Word definitions have to be in plain text, separated by newlines.
CZ <-> { EN, DE, PL, RU } dictionaries: https://mega.co.nz/#!axtD0QRK!sbtBgizksyfkPqKvKEgr8GQ11rsWhtqyRgUUV0B7pwg[
https://mega.co.nz/#!axtD0QRK!sbtBgizksyfkPqKvKEgr8GQ11rsWhtqyRgUUV0B7pwg CZ <--> { EN, DE, PL, RU } dictionaries]
Contributing and Support Contributing and Support
------------------------ ------------------------
@ -72,7 +75,7 @@ the developer, feel free to join me at irc://anathema.irc.so, channel #anathema.
License License
------- -------
`sdtui' is written by Přemysl Janouch <p.janouch@gmail.com>. 'sdtui' is written by Přemysl Janouch <p.janouch@gmail.com>.
You may use the software under the terms of the ISC license, the text of which You may use the software under the terms of the ISC license, the text of which
is included within the package, or, at your option, you may relicense the work is included within the package, or, at your option, you may relicense the work