Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ThomasOldham authored Mar 6, 2019
1 parent b5108c4 commit 1f42745
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@

# polyverse/ropoly

## Build Instructions
Run "go build"

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

Usage: `ropoly server`

### daemon
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.
Runs as a daemon that repeatedly scans the server's file system and the libraries of its running processes to check for Polyverse signatures.

Usage: `ropoly daemon`

## ROPoly API Endpoints

Expand Down Expand Up @@ -105,4 +106,4 @@ For each gadget, starts with a "quality" value of 1, and multiplies it by the co
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.

#### additive-with-ceiling
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.
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 comments on commit 1f42745

Please sign in to comment.