Browse Source

Miscellaneous little changes

Přemysl Janouch 3 years ago
parent
commit
f9c308765f
2 changed files with 30 additions and 22 deletions
  1. 9
    6
      .gitignore
  2. 21
    16
      README

+ 9
- 6
.gitignore View File

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

+ 21
- 16
README View File

@@ -1,26 +1,31 @@
1
-StarDict terminal UI
1
+StarDict Terminal UI
2 2
 ====================
3 3
 
4
-This program aims to provide an easy way of viewing translation and other kinds
5
-of dictionaries in your terminal.  The author wasn't successful in finding any
6
-free dictionary software of this type, GUI or not, and thus decided to write his
7
-own.
4
+`sdtui' aims to provide an easy way of viewing translation as well as other
5
+kinds of dictionaries in your terminal.  I wasn't successful in finding any free
6
+dictionary software of this kind, GUI or not, and thus decided to write my own.
8 7
 
9
-The project is covered by a BSD-style license, unlike vast majority of other
8
+The project is covered by a permissive license, unlike vast majority of other
10 9
 similar projects, and can serve as a base for implementing other dictionary
11
-software under a more permissive license than your usual GNU General Public
12
-License.  I'll buy you a beer for shouting obscenities at the address of RMS in
13
-public; I couldn't reuse _anything_.
10
+software.  I wasn't able to reuse _anything_.
14 11
 
15
-Some work has to be done yet before the software can be considered fit for
16
-inclusion in regular Linux and BSD distributions.  Help is much appreciated in
17
-this regard.
12
+Further Development
13
+-------------------
14
+While I've been successfully using sdtui for a long time now, some work has to
15
+be done yet before the software can be considered fit for inclusion in regular
16
+Linux and/or BSD distributions.  Help is much appreciated.
17
+
18
+An approximate list of things that need to be resolved:
19
+ - rewrite the frontend using a proper TUI framework
20
+ - load a list of installed dictionaries at startup (use the default locations
21
+   used by StarDict) and let the user choose which dictionary to open
22
+ - figure out a way to become capable of displaying most dictionaries
18 23
 
19 24
 Building and Running
20 25
 --------------------
21
-Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl,
22
-                    ncursesw, zlib, ICU, termo (included),
23
-                    glib-2.0, pango, gtk+ (optional, any version)
26
+Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl
27
+Runtime dependencies: ncursesw, zlib, ICU, termo (included),
28
+                      glib-2.0, pango, gtk+ (optional, any version)
24 29
 
25 30
  $ git clone https://github.com/pjanouch/sdtui.git
26 31
  $ git submodule init
@@ -31,7 +36,7 @@ Build dependencies: CMake, pkg-config, xsltproc, docbook-xsl,
31 36
  $ make
32 37
 
33 38
 To install the application, you can do either the usual:
34
- $ make install
39
+ # make install
35 40
 
36 41
 Or you can try telling CMake to make a package for you.  For Debian it is:
37 42
  $ cpack -G DEB

Loading…
Cancel
Save