From a7bb8d8deb32bf3dbd7f1e066ff973dda9a95936 Mon Sep 17 00:00:00 2001 From: chteufleur Date: Tue, 20 Oct 2015 16:29:43 +0200 Subject: [PATCH 1/2] Complete the README --- README.md | 44 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f0e76d6..0e1a3fc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,42 @@ -go-xmpp4steam -============= +# go-xmpp4steam -A XMPP/Steam gateway. \ No newline at end of file + +go-xmpp4steam is a XMPP/Steam gateway. + + +## Compilation +### Dependencies + + * [go-xmpp](https://git.kingpenguin.tk/chteufleur/go-xmpp) for the XMPP part. + * [go-steam](https://github.com/Philipp15b/go-steam) for the steam part. + * [cfg](https://github.com/jimlawless/cfg) for the configuration file. + + +Go into your $GOPATH directory and execut those two line to get the 2 dependencies (cfg and go-steam). +```sh +go get github.com/Philipp15b/go-steam +go get github.com/jimlawless/cfg +``` +After that, go into ``src`` directory and get the go-xmpp sources dependence. +```sh +git clone https://git.kingpenguin.tk/chteufleur/go-xmpp +``` + +### Download sources +Then download and compile the go-xmpp4steam gateway. +```sh +git clone https://git.kingpenguin.tk/chteufleur/go-xmpp4steam.git +cd go-xmpp4steam +go build main.go +``` +A binary file will be generated. + +### Configure +Configure the gateway by editing the ``xmpp4steam.cfg`` file. +The first time, let the variable ``steam_auth_code`` empty. After the first run of the gateway, Steam will send you a code that you have to give it in that variable. Then re-run the gateway and it should be OK. + + +## Help +To get any help, please visit the XMPP conference room : + * [With your own XMPP client](xmpp:go-xmpp4steam@muc.kingpenguin.tk) + * [With your browser](https://jappix.kingpenguin.tk/?r=go-xmpp4steam@muc.kingpenguin.tk) \ No newline at end of file From f46dd676f9b3915105d19908bb6d483dbb24be70 Mon Sep 17 00:00:00 2001 From: chteufleur Date: Tue, 20 Oct 2015 16:53:59 +0200 Subject: [PATCH 2/2] Modify README because of missing xmpp link implementation --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 0e1a3fc..13d7207 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,4 @@ The first time, let the variable ``steam_auth_code`` empty. After the first run ## Help -To get any help, please visit the XMPP conference room : - * [With your own XMPP client](xmpp:go-xmpp4steam@muc.kingpenguin.tk) - * [With your browser](https://jappix.kingpenguin.tk/?r=go-xmpp4steam@muc.kingpenguin.tk) \ No newline at end of file +To get any help, please visit the XMPP conference room at ``go-xmpp4steam@muc.kingpenguin.tk`` with your prefered client, or [with your browser](https://jappix.kingpenguin.tk/?r=go-xmpp4steam@muc.kingpenguin.tk). \ No newline at end of file