Skip to content

Commit 1f42745

Browse files
authored
Update README.md
Removed the build instructions for now because they are not very useful as they are. We probably need separate instructions for Linux and Windows, with at least a link to instructions for getting GCC on Windows. Provided usage examples for running the program.
1 parent b5108c4 commit 1f42745

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44

55
# polyverse/ropoly
66

7-
## Build Instructions
8-
Run "go build"
9-
107
## Run Instructions for Docker
118
The container must be run with --privileged
129
Port 8008 must be mapped to a port on the host with -p in order to interact with client.
@@ -18,8 +15,12 @@ Example (run from Ropoly directory): docker run --rm -it -v $PWD:/go/src/github.
1815
### server
1916
Runs as a server exposing the API described under "Ropoly API Endpoints."
2017

18+
Usage: `ropoly server`
19+
2120
### daemon
22-
Runs as a daemon that repeatedly scans the server's file system and the libraries of its running processes to check for Polyverse signatures. Use this option, "server", or both.
21+
Runs as a daemon that repeatedly scans the server's file system and the libraries of its running processes to check for Polyverse signatures.
22+
23+
Usage: `ropoly daemon`
2324

2425
## ROPoly API Endpoints
2526

@@ -105,4 +106,4 @@ For each gadget, starts with a "quality" value of 1, and multiplies it by the co
105106
Adds the penalty for each gadget offset, so that for example a gadget with two offsets each shared with _n_ other gadgets would incur twice the EQI penalty a gadget with a single offset shared with _n_ other gadgets. The same as _count-poly_ with the default _order_ of 2.0 and _single_=false.
106107

107108
#### additive-with-ceiling
108-
Adds the penalty for each gadget offset, but caps the contribution of each individual gadget to the EQI at 100 divided by the total number of gadgets.
109+
Adds the penalty for each gadget offset, but caps the contribution of each individual gadget to the EQI at 100 divided by the total number of gadgets.

0 commit comments

Comments
 (0)