Skip to content

Commit 2e722a6

Browse files
committedJun 15, 2016
Unified README to match the language service ones
1 parent 919c74b commit 2e722a6

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed
 

‎README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# WebSocket ZeroMQ Proxy
22

3-
Proxy that forwards messages between ZeroMQ and WebSockets. This proxy must run, so that [editor-browser](https://github.com/monto-editor/editor-browser) can communicate with the [broker](https://github.com/monto-editor/broker). This project is build using Gradle.
3+
Proxy that forwards messages between ZeroMQ and WebSockets. This proxy must run, so that [editor-browser](https://github.com/monto-editor/editor-browser) can communicate with the [broker](https://github.com/monto-editor/broker).
4+
5+
## Building
6+
Builds and dependencies are managed with Gradle.
7+
8+
`./gradlew shadowJar` builds a jar that includes all dependencies (using [Shadow](https://github.com/johnrengelman/shadow)) under `build/libs/websocket-zmq-proxy-all.jar`.
9+
10+
11+
## Running
12+
Start with `./start.sh`.
13+
14+
15+
## Developing
16+
Setup your favorite IDE, then run or debug the [Main.java](src/main/java/monto/broker/websocket/Main.java) class and set the CLI arguments to the ones used in the `start.sh` script.
417

518
## IntelliJ setup
619
After cloning, use the `Import Project` or `File -> New -> Project from Existing Sources...` feature and select the `build.gradle` to start the import.
@@ -9,6 +22,3 @@ After cloning, use the `Import Project` or `File -> New -> Project from Existing
922
Make sure you have an up-to-date Buildship Gradle Plug-in installed. At the time of writing Eclipse 4.5.2 (Mars 2) is the newest stable Eclipse build. It ships with the Buildship Gradle Plug-in version 1.0.8, but you will need at least 1.0.10, because of [these changes](https://discuss.gradle.org/t/gradle-prefs-contains-absolute-paths/11475/34). To update Buildship, use the Eclipse Marketplace's `Installed` tab.
1023

1124
After cloning, use the `File -> Import -> Existing Projects into Workspace` feature and select the root folder of this repository to start the import.
12-
13-
## Running services
14-
Run or debug the [Main](src/monto/broker/wensocket/Main.java) class and set the CLI arguments to the ones used in the `start.sh` script.

0 commit comments

Comments
 (0)
Please sign in to comment.