Skip to content

Commit

Permalink
Updated read.me file
Browse files Browse the repository at this point in the history
  • Loading branch information
fmoghaddam committed Oct 27, 2016
1 parent ed9acbf commit 4d33b17
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Hi-Rec (A Java Framework for Recommender Systems)
-------------

[![Build Status](https://travis-ci.org/fmoghaddam/RecommendationEngine.svg?branch=master)](https://travis-ci.org/fmoghaddam/RecommendationEngine)
[![Build Status](https://travis-ci.org/fmoghaddam/Hi-Rec.svg?branch=master)](https://travis-ci.org/fmoghaddam/Hi-Rec)

**Hi-Rec** is a Java framework for recommender systems (Java version 1.8 or higher required). This framework is Cross-Platform, Open Source , Extensible and Easy to Use. It not only implements state-of-art algorithms but only makes it possible for others to extend it and implement more user-specific algorithms. This framework developed to be used across with [Mise-en-scène Project](http://recsys.deib.polimi.it/?page_id=246).

Expand All @@ -21,7 +21,7 @@ Hi-Rec (A Java Framework for Recommender Systems)
- Recall
- NDCG

**Implemeted Features:**
**Implemented Features:**

- Low Level Features (Related to [Mise-en-scène
Project](http://recsys.deib.polimi.it/?page_id=246))
Expand All @@ -35,7 +35,7 @@ This project is based on [Gradle](https://gradle.org/). So it could be easily im

**Running in Terminal**

For running the project, you only need to modify `config.properties` in `build/install/RecommendationEngine/bin` and then run `build/install/RecommendationEngine/bin/RecommendationEngine.bat` or `build/install/RecommendationEngine/bin/RecommendationEngine.sh`.
For running the project, you only need to modify `config.properties` in `build/install/Hi-Rec/bin` and then run `build/install/Hi-Rec/bin/Hi-Rec.bat` or `build/install/Hi-Rec/bin/Hi-Rec.sh`.

**Code structure**

Expand Down Expand Up @@ -184,9 +184,9 @@ FAQ
### 1. How to run the project without importing it to Eclipse?
As this project is based on Gradle, it can be simply run. If you want to run it without changing any java code, then just do the following steps:
* Download the repository
* In `cmd` or `terminal` go to `build/install/RecommendationEngine/bin`
* In `cmd` or `terminal` go to `build/install/Hi-Rec/bin`
* Change `config.properties` and modify it based on your use case
* Run `RecommendationEngine.bat` or `RecommendationEngine.sh`
* Run `Hi-Rec.bat` or `Hi-Rec.sh`

### 2. I want to change the java code and run the project without importing it into Eclipse, How can I do that?
You can open any of the java classes in your favorite editor such as `notepad` and change the code. Then you can build and run the code with the following steps:
Expand Down

0 comments on commit 4d33b17

Please sign in to comment.