Update README.md

jgrivolla · Apr 25, 2013 · dc6e3c8 · dc6e3c8
1 parent eb5e607
commit dc6e3c8
Showing 1 changed file with 5 additions and 2 deletions.
diff --git 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: `<item_id1>:<score1>,<item_id2>:<score2>,...`
+ - be careful to correctly urlencode your parameter before sending it to the myrrix serving layer
+ - only the first `rescorerParams` argument will be used