Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alxrm authored Dec 7, 2017
1 parent 18c2a01 commit c5a5de8
Showing 1 changed file with 8 additions and 18 deletions.
26 changes: 8 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,39 +18,27 @@

If you simply need the working product, just go [here](https://github.com/alxrm/presento/releases) and download executable binary file for your platform

### Manual building
### Install

For those who want to build it manually. Presento is written in Go so you'll need to [install Go first](https://golang.org/dl/). Once that's done, you can build the app. First get the source:
For those who want to install it as a tool for terminal. Presento is written in Go so you'll need to [install Go first](https://golang.org/dl/). Once that's done, you can install the thing. Just run this:

```bash
$ go get -v github.com/alxrm/presento
$ go get github.com/alxrm/presento
```

then go to the directory:
_That's it! Now you can always access it in terminal:_

```bash
$ cd $GOPATH/src/github.com/alxrm/presento
$ presento
```

and run:

```bash
$ go build .
```

This should generate a `presento` binary.

Or if you use [goxc](https://github.com/laher/goxc), sure, why not, but check the [Contribution](https://github.com/alxrm/presento#contributing) chapter first

_That html file, which is served via static server is also included in the binary, just use `$ go generate` before build everytime you change the html file, more on that [here](https://github.com/bouk/file2const)_

## Usage

__NOTE: The only requirement is your cellphone has to be in the same Wi-fi network as your laptop, it simply would not work otherwise__

As you can(or cannot) see on the GIF above, the flow is pretty simple:

1) You launch the executable file, it will open the command line app with this text in it:
1) You launch the executable file(or run it from terminal if you istalled it), it will open the command line app with this text in it:

```
Go to http://192.168.0.**:5000/**** to control
Expand Down Expand Up @@ -91,6 +79,8 @@ _"Well it would be nice to have the ability to change the slides, like all those

Presento has some problems with building for Linux with [goxc](https://github.com/laher/goxc) on the OS X, whilst it seems to be fine for the Windows/OS X. The problem comes from this awesome [library](https://github.com/micmonay/keybd_event), so if you can help it, you're more than welcome!

_That html file, which is served via static server is also included in the binary, just use `$ go generate` before build everytime you change the html file, more on that [here](https://github.com/bouk/file2const)_

## License

MIT License. See the [LICENSE](LICENSE) file for more information.

0 comments on commit c5a5de8

Please sign in to comment.