[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] 205/255: update the README
From: |
Eric Schulte |
Subject: |
[elpa] 205/255: update the README |
Date: |
Sun, 16 Mar 2014 01:02:49 +0000 |
eschulte pushed a commit to branch go
in repository elpa.
commit 528d315ba799cb1f9a7c695b921d99e18d9d8e2b
Author: Eric Schulte <address@hidden>
Date: Tue May 21 10:22:39 2013 -0600
update the README
---
README.md | 25 ++++++++++++++++---------
1 files changed, 16 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 29546f5..3c0e955 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,17 @@
-el-go --- Emacs interface to GO protocols and backends
-------------------------------------------------------
+el-go --- Emacs interface to the game of GO
+-------------------------------------------
- play GO
- interact with GO back ends and protocols through a board
-- translate between GO back ends and protocols
+- translate between multiple GO back ends and protocols
-A board-based interface to GO games which may be connected to a number
-of GO back-ends through a generic API. To play a game of GO run
-`play-go`. Back-ends include the SGF format, the Go Text Protocol
-(GTP), the IGS protocol (in progress).
+A board-based interface to the game of GO which may be connected to a
+number of GO back-ends through a generic API. Back-ends include the
+[Smart Game Format](http://senseis.xmp.net/?SmartGameFormat) (SGF),
+the [Go Text Protocol](http://www.lysator.liu.se/~gunnar/gtp/) (GTP)
+which may be used to play against gnugo, and the
+[Internet Go Server](http://en.wikipedia.org/wiki/IGS_Go_server) (IGS)
+protocol (in progress).
Usage
-----
@@ -16,7 +19,11 @@ Usage
1. Load this library.
(require 'go)
-
+
2. Play Go.
- (play-go)
+ M-x go-play
+
+3. View an SGF file of a saved game.
+
+ M-x go-view-sgf
- [elpa] 188/255: adding README, (continued)
- [elpa] 188/255: adding README, Eric Schulte, 2014/03/15
- [elpa] 199/255: marking captured territory when game ends, Eric Schulte, 2014/03/15
- [elpa] 197/255: use new mark machinery to apply labels, Eric Schulte, 2014/03/15
- [elpa] 195/255: query backend for territory, Eric Schulte, 2014/03/15
- [elpa] 201/255: print score after marking territory, Eric Schulte, 2014/03/15
- [elpa] 189/255: replace flet with cl-flet, Eric Schulte, 2014/03/15
- [elpa] 190/255: set level (mainly for playing GNUGO), Eric Schulte, 2014/03/15
- [elpa] 204/255: prefix external names with package name, Eric Schulte, 2014/03/15
- [elpa] 165/255: working on placing backgrounds behind pieces, Eric Schulte, 2014/03/15
- [elpa] 202/255: added interface function to view an SGF file, Eric Schulte, 2014/03/15
- [elpa] 205/255: update the README,
Eric Schulte <=
- [elpa] 206/255: ensure prisoners are 0 at the start of a new game, Eric Schulte, 2014/03/15
- [elpa] 208/255: support for viewing lists in a buffer, Eric Schulte, 2014/03/15
- [elpa] 207/255: robustly handle prematurely quitting process, Eric Schulte, 2014/03/15
- [elpa] 209/255: adding curry, rcurry and compose helpers, Eric Schulte, 2014/03/15
- [elpa] 213/255: include headers in width calculation, Eric Schulte, 2014/03/15
- [elpa] 215/255: smaller ldots, Eric Schulte, 2014/03/15
- [elpa] 200/255: refresh the go board, Eric Schulte, 2014/03/15
- [elpa] 214/255: refresh list every time the buffer changes size, Eric Schulte, 2014/03/15
- [elpa] 212/255: bug fix, wrong function name, Eric Schulte, 2014/03/15
- [elpa] 225/255: quit observing IGS game w/o closing connection, Eric Schulte, 2014/03/15