diff --git a/README.md b/README.md index 2b2da9f..17ac417 100644 --- a/README.md +++ b/README.md @@ -2,56 +2,39 @@ This work-in-progress represents a prototype semantic search web application that I'm developing as part of my master's thesis at [Keio University](http://www.sfc.keio.ac.jp/). You can get a better understanding of the goals of my research -by referring to the [overview presentation](https://foosoft.net/projects/restaurant-search/slides). +by referring to the [overview presentation](https://foosoft.net/projects/restaurant-search/slides). Although I no longer make the prototype accessible on the web, it +is easy to get it up and running locally. -This installation guide is designed with [Ubuntu](http://www.ubuntu.com/)-based distributions in mind (I'm using [Linux -Mint](http://www.linuxmint.com/) for development), but I expect it to be trivial to get this application running on -other flavors of Linux. + + +## Dependencies ## + +* [Bower](https://bower.io/) +* [Go](https://golang.org/) +* [Node.js](https://nodejs.org/) ## Installation ## -1. Install the system dependencies: - - ``` - # apt-get install nodejs-legacy nodejs npm - ``` - -2. Install the Node dependencies: - - ``` - # npm install -g bower - ``` - -3. Install the Go tool chain: - - ``` - $ wget https://godeb.s3.amazonaws.com/godeb-amd64.tar.gz - $ tar xzvf godeb-amd64.tar.gz - # ./godeb install - ``` - -4. Set the `GOPATH` environment variable (read the [docs](https://github.com/golang/go/wiki/GOPATH)). - -5. Install the search application: +1. Install the search application: ``` $ go get github.com/FooSoft/search ``` -6. Install the client libraries (from the `search/static` directory): +2. Install the client libraries (from the `search/static` directory): ``` $ bower install ``` -7. Build and start the server (from the `search/cmd` directory): +3. Build and start the server (from the `search/cmd` directory): ``` $ go build $ ./cmd ``` -8. Access the web application at `localhost:8080`. +4. Access the web application at `localhost:8080`. ## License ##