From 7e9fd69879fa73102f8220fa1b749c796878425a Mon Sep 17 00:00:00 2001 From: Chteufleur Date: Tue, 9 Aug 2016 22:58:28 +0200 Subject: [PATCH] Add how to build and run the project into readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ead41a5..37f5b96 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,24 @@ Provide an HTTP anthentification over XMPP. Implementation of [XEP-0070](https:/ Can be run as a XMPP client or XMPP component. -## Compilation ### Dependencies * [go-xmpp](https://git.kingpenguin.tk/chteufleur/go-xmpp) for the XMPP part. * [cfg](https://github.com/jimlawless/cfg) for the configuration file. +### Build and run + You must first [install go environment](https://golang.org/doc/install) on your system. Then, go into your $GOPATH directory and go get the source code. ```sh go get git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP.git ``` +First, you need to go into directory ``$GOPATH/src/chteufleur/HTTPAuthentificationOverXMPP.git``. +Then, you can run the project directly by using command ``go run main.go``. +Or, in order to build the project you can run the command ``go build main.go``. +It will generate a binary that you can run as any binary file. + ### Configure Configure the gateway by editing the ``httpAuth.cfg`` file in order to give all XMPP and HTTP server informations. An example of the config file can be found in [the repos](https://git.kingpenguin.tk/chteufleur/HTTPAuthentificationOverXMPP/src/master/httpAuth.cfg).