diff --git a/README.md b/README.md index aade0d5..7f95b5b 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,11 @@ example of building a myrrix recommender with a rescorer # Compiling - run `mvn clean install` from project root - - myrrix-web/src/main/webapp/WEB-INF/web.xml points to the rescorer to use + - `myrrix-web/src/main/webapp/WEB-INF/web.xml` points to the rescorer to use # Running - - deploy myrrix-web/target/myrrix-web.war on servlet container (e.g. Tomcat) + - deploy `myrrix-web/target/myrrix-web.war` on servlet container (e.g. Tomcat) + - pass rescoring parameters in the following format: `:,:,...` + - be careful to correctly urlencode your parameter before sending it to the myrrix serving layer + - only the first `rescorerParams` argument will be used