Miscellaneous little changes

This commit is contained in:
Přemysl Eric Janouch 2015-02-26 22:58:40 +01:00
parent 2f0852ec05
commit f9c308765f
2 changed files with 30 additions and 22 deletions

15
.gitignore vendored
View File

@ -1,6 +1,9 @@
# Backup files # Build files
*.*~ /build
# IDE project files
/CMakeLists.txt.user # Qt Creator files
# Blah /CMakeLists.txt.user*
/.clang_complete /sdtui.config
/sdtui.files
/sdtui.creator*
/sdtui.includes

37
README
View File

@ -1,26 +1,31 @@
StarDict terminal UI StarDict Terminal UI
==================== ====================
This program aims to provide an easy way of viewing translation and other kinds `sdtui' aims to provide an easy way of viewing translation as well as other
of dictionaries in your terminal. The author wasn't successful in finding any kinds of dictionaries in your terminal. I wasn't successful in finding any free
free dictionary software of this type, GUI or not, and thus decided to write his dictionary software of this kind, GUI or not, and thus decided to write my own.
own.
The project is covered by a BSD-style license, unlike vast majority of other The project is covered by a permissive license, unlike vast majority of other
similar projects, and can serve as a base for implementing other dictionary similar projects, and can serve as a base for implementing other dictionary
software under a more permissive license than your usual GNU General Public software. I wasn't able to reuse _anything_.
License. I'll buy you a beer for shouting obscenities at the address of RMS in
public; I couldn't reuse _anything_.
Some work has to be done yet before the software can be considered fit for Further Development
inclusion in regular Linux and BSD distributions. Help is much appreciated in -------------------
this regard. While I've been successfully using sdtui for a long time now, some work has to
be done yet before the software can be considered fit for inclusion in regular
Linux and/or BSD distributions. Help is much appreciated.
An approximate list of things that need to be resolved:
- rewrite the frontend using a proper TUI framework
- load a list of installed dictionaries at startup (use the default locations
used by StarDict) and let the user choose which dictionary to open
- figure out a way to become capable of displaying most dictionaries
Building and Running Building and Running
-------------------- --------------------
Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl, Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl
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)
$ git clone https://github.com/pjanouch/sdtui.git $ git clone https://github.com/pjanouch/sdtui.git
$ git submodule init $ git submodule init
@ -31,7 +36,7 @@ Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl,
$ 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