-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
The FreeChessClub Author(s)
committed
Jun 2, 2019
1 parent
6945642
commit 5e3336f
Showing
46 changed files
with
13,917 additions
and
768 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,33 @@ | ||
# icsgo | ||
|
||
Play free online chess at [Free Chess Club](http://www.freechess.club). | ||
[](https://travis-ci.org/freechessclub/icsgo) | ||
[](https://godoc.org/github.com/freechessclub/icsgo) | ||
[](https://goreportcard.com/report/github.com/freechessclub/icsgo) | ||
|
||
icsgo is a Go client library to connect to [Internet Chess Server (ICS)](https://en.wikipedia.org/wiki/Internet_chess_server). An ICS provides support for playing, watching and discussing chess games. Two popular, and among the earliest, examples of ICS include: | ||
* [Free Internet Chess Server (FICS)](http://www.freechess.org/) | ||
* [Internet Chess Club (ICC)](http://www.chessclub.com/) | ||
|
||
Although the ICS protocol is a simple variant of the TELNET protocol, it has | ||
not been standardised. As such, this has led to different ICS servers | ||
implementing non-standard extensions to the protocol. | ||
|
||
Installation | ||
------------ | ||
To install this package, you need to have a working installation of Go. | ||
Assuming you have Go properly installed, simply do: | ||
|
||
``` | ||
go get -u github.com/freechessclub/icsgo | ||
``` | ||
|
||
Usage | ||
----- | ||
If you're using Go modules (Go 1.11+), this library can be used by simply | ||
importing `"github.com/freechessclub/icsgo"` in your application. Using the usual Go commands `go [build|run|test]` will automatically download the required dependencies. | ||
|
||
Documentation | ||
------------- | ||
* See [godoc](https://godoc.org/github.com/freechessclub/icsgo) for package documentation. | ||
* Examples on how to use the library can be found in the [examples](examples/) directory. | ||
|
Oops, something went wrong.