mirror of
https://github.com/xiaoyifang/goldendict-ng.git
synced 2024-11-27 19:24:08 +00:00
Added proper README
This commit is contained in:
parent
7be709f421
commit
fa9c980fef
49
README.md
Normal file
49
README.md
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
<b>GoldenDict</b> is a feature-rich dictionary lookup program, supporting multiple dictionary formats (StarDict/Babylon/Lingvo/Dictd/AARD/MDict/SDict) and online dictionaries, featuring perfect article rendering with the complete markup, illustrations and other content retained, and allowing you to type in words without any accents or correct case.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
This code has been run and tested on Windows XP/Vista/7, Ubuntu Linux, Mac OS X.
|
||||||
|
|
||||||
|
### External Deps
|
||||||
|
|
||||||
|
* Make, GCC
|
||||||
|
* Qt framework 4.7.* or 4.8.*
|
||||||
|
* Qt Creator IDE is recommended for development
|
||||||
|
* Various libraries on Linux (png, zlib, etc)
|
||||||
|
* On Mac and Windows all the libraries are already included in the repository
|
||||||
|
|
||||||
|
### Installing External Deps on Ubuntu Linux
|
||||||
|
|
||||||
|
sudo apt-get install pkg-config build-essential qt4-qmake \
|
||||||
|
libvorbis-dev zlib1g-dev libhunspell-dev x11proto-record-dev \
|
||||||
|
qt4-qmake libqt4-dev libxtst-dev libphonon-dev liblzo2-dev libbz2-dev
|
||||||
|
|
||||||
|
## How to build
|
||||||
|
|
||||||
|
First, clone this repository, e.g.:
|
||||||
|
|
||||||
|
git clone git://github.com/goldendict/goldendict.git
|
||||||
|
|
||||||
|
And then invoke `qmake` and `make`:
|
||||||
|
|
||||||
|
cd goldendict && qmake && make
|
||||||
|
|
||||||
|
Alternatively, you might want to load `goldendict.pro` file from within Qt Creator, especially on Windows.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Installation is an optional step since the built binary can be used as-is without installation. But you can properly install via:
|
||||||
|
|
||||||
|
make install
|
||||||
|
|
||||||
|
<b>NB:</b> Don't do that on Windows!
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
This project is licensed under the <b>GNU GPLv3+</b> license, a copy of which can be found in the `LICENSE.txt` file.
|
||||||
|
|
||||||
|
## Support
|
||||||
|
|
||||||
|
Users looking for support should file an issue on the [GitHub issue tracking page](https://github.com/goldendict/goldendict/issues), or file a [pull request](https://github.com/goldendict/goldendict/pulls) if you have a fix available. General questions should be asked on the [official GoldenDict forum](http://goldendict.org/forum/).
|
Loading…
Reference in a new issue