[hitori/readme-md] docs: Port README to Markdown
- From: Philip Withnall <pwithnall src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [hitori/readme-md] docs: Port README to Markdown
- Date: Tue, 19 Feb 2019 15:55:47 +0000 (UTC)
commit f65d5f657d340f1d0b8e55c9bacfe0f5773941f2
Author: Philip Withnall <withnall endlessm com>
Date: Tue Feb 19 15:54:59 2019 +0000
docs: Port README to Markdown
Make it a bit more readable.
Signed-off-by: Philip Withnall <withnall endlessm com>
README | 57 ---------------------------------------------------------
README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 50 insertions(+), 57 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e5f7bd9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+Hitori
+======
+
+Hitori is a GTK+ application to generate and let you play games of Hitori, a logic game similar to Sudoku
created by Nikoli.
+
+News
+====
+
+See NEWS file.
+
+Dependencies
+============
+
+[GNOME 3.0 development platform](http://www.gnome.org)
+
+Controls
+========
+
+ * Left-click on a cell: Paint/Unpaint cell
+ * Ctrl+Left-click on a cell: Tag cell
+ * Shift+Left-click on a cell: Tag cell
+ * Ctrl+N: New game
+ * Ctrl+H: Display a hint
+ * Ctrl+Z: Undo last move
+ * Ctrl+Shift+Z: Redo last undone move
+ * Ctrl+Q: Quit
+
+Copyright
+=========
+
+ * Philip Withnall <philip tecnocode co uk>
+ * Algorithm assistance from Ben Windsor <benjw_823 hotmail com>
+ * Icon by Jakub Szypulka <cube szypulka com>
+
+BUGS
+====
+
+Bugs should be entered in [GNOME GitLab](https://gitlab.gnome.org/GNOME/hitori/issues).
+
+To get a better debug output, run:
+```
+hitori --debug
+```
+
+Contact
+=======
+
+Philip Withnall <philip tecnocode co uk>
+
+https://wiki.gnome.org/Apps/Hitori
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]