summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorgregory guy <gregory-tde@laposte.net>2019-11-01 11:46:21 +0100
committergregory guy <gregory-tde@laposte.net>2019-11-01 11:46:21 +0100
commit873d0e4138a1569d2a8dfa061d0338b6d017dd3b (patch)
tree330519cff76d1948c74f7674793cdc1399fee3d6 /README
parent620d83c4efc5ffcbf89d941410dbddda4daff279 (diff)
downloadknights-873d0e4138a1569d2a8dfa061d0338b6d017dd3b.tar.gz
knights-873d0e4138a1569d2a8dfa061d0338b6d017dd3b.zip
Drop automake build support.
Add basic cmake build instructions in the INSTALL file. Rework of README file and the help page. The History file has been removed, the content added to the ChangeLog file. The file CreatingThemes has moved in the doc folder. Cosmetic changes in CMakeLists.txt . Signed-off-by: gregory guy <gregory-tde@laposte.net>
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 33 insertions, 24 deletions
diff --git a/README b/README
index a3dfb90..0312ed7 100644
--- a/README
+++ b/README
@@ -1,26 +1,24 @@
-Knights - A chess interface for the Trinity Desktop Environment
-FOR INSTALLATION INSTRUCTIONS, SEE THE "INSTALL" FILE
+Knights - A chess interface (GUI) for the Trinity Desktop Environment
-- What Is Knights?
-Knights is a graphical chess interface designed to work with TDE. Knights
-is called a chess 'interface' because it does not come with it's own computer
-players. There are several very good computer players ( Chess Engines )
-already. Unfortunatly, most chess engines do not include fully featured GUIs.
-Instead, they rely on other programs ( like Knights ) to fill the gap.
-- How can I learn more about Knights?
+Knights is a graphical chess interface designed to work with TDE.
+It's designed to be both friendly to new chess players and
+functional for Grand Masters. Knights is called a chess "interface"
+because it does not come with it's own computer players. There are
+several computer players ( Chess Engines ) already. Unfortunatly, most
+chess engines do not include fully featured GUIs. Instead, they rely on
+other programs ( like Knights ) to fill the gap.
-If you're interested in learning more, you should visit our project's website
-at http://knights.sourceforge.net
-- What Chess Engines work with Knights?
+- What Chess Engines can work with Knights?
-Knights should support any engine which uses the XBoard protocol developed by
-Tim Mann. Knights will also offer it's own protocol for future use. To date,
-the following chess engines have been confirmed to work with Knights. If you
-know of another, please let me know so I can update this list.
+Knights should support any engine which uses the XBoard protocol
+developed by Tim Mann. Knights will also offer it's own protocol for
+future use. To date, the following chess engines have been confirmed
+to work with. If you know of another, please let we know so we can
+update this list.
- GNUChess v4.0 patchlevel 80
- GNUChess v5.02
@@ -30,15 +28,26 @@ know of another, please let me know so I can update this list.
- Sjeng v10.0
- BabyChess
-- What can I do to help Knights?
-Knights can always use help in a number of areas. The best way to get started
-would be to express your interests on the knights-devel mailing list. You can
-sign up from here:
+- List of Knights' key features:
- http://sourceforge.net/mail/?group_id=31461
+ * Play against yourself, against computer opponents,
+ or against others over the Internet.
+ * Customize your board and pieces with over 30 different themes,
+ or make your own!
+ * Audio cues help alert you to important events.
+ * Novice players can preview potential moves.
+ * Save your unfinished matches and play them again later.
+
-Currently, we're very interested in talking to a graphics artist about
-designing some new themes, and we would like to talk to some advanced
-chess players about helping to develop the tutorials.
+ CONTRIBUTING
+==============
+
+If you wish to contribute to knights (TDE), you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+ https://mirror.git.trinitydesktop.org/weblate