Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Prateek Kumar <[email protected]>
  • Loading branch information
prateekkumarweb committed Aug 13, 2018
1 parent ff65455 commit 05d66a9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
21 changes: 9 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ This project generates a timetable given a set of inputs and constraints. It enc

## Installation

**For ubuntu users:** Download deb for the latest version of Timetabler from [here](https://github.com/GoodDeeds/Timetabler/releases) and install it.

To build the project from source follow the steps below.

### Prerequisities

This project requires following tools to build.
Expand All @@ -16,18 +20,11 @@ This project requires following tools to build.
### Dependencies

The following software are dependencies for this program:
* **Open WBO 2.0** :
This is the MaxSAT solver used to solve the encoded formula. The code can be downloaded from [here](https://github.com/sat-group/open-wbo/tree/f193a3bd802551b13d6424bc1baba6ad35ec6ba6). Setup instructions are provided below. Also see the [project website](http://sat.inesc-id.pt/open-wbo/) for details.
* **yaml-cpp 0.5.3** :
This is used to parse valid field values and weight inputs. Download and install from [here](https://github.com/jbeder/yaml-cpp/releases/tag/yaml-cpp-0.5.3).
* **CSVparser** :
This is used to parse the CSV containing the input data. Download from [here](https://github.com/MyBoon/CSVparser/tree/540e3e2f46b77ea8178f90910a165695cbb6cc12). Setup instructions are provided below.
* **PEGTL 2.2.0** :
This is used to parse custom constraints. Download and install from [here](https://github.com/taocpp/PEGTL/releases/tag/2.2.0).
* **googletest 1.8.0** :
This is required if tests are to be run. Download and install from [here](https://github.com/google/googletest/releases/tag/release-1.8.0).

`g++` with support for C++11, using the `--std=c++11` flag, is required.
* [**Open WBO 2.0**](https://github.com/GoodDeeds/open-wbo): Slightly modified version of the original [Open-WBO 2.0](https://github.com/sat-group/open-wbo/tree/f193a3bd802551b13d6424bc1baba6ad35ec6ba6).
* [**yaml-cpp 0.5.3**](https://github.com/jbeder/yaml-cpp/releases/tag/yaml-cpp-0.5.3)
* [**CSVparser**](https://github.com/MyBoon/CSVparser/tree/540e3e2f46b77ea8178f90910a165695cbb6cc12)
* [**PEGTL 2.2.0**](https://github.com/taocpp/PEGTL/releases/tag/2.2.0)
* [**googletest 1.8.0**](https://github.com/google/googletest/releases/tag/release-1.8.0)

### Setting up the dependencies

Expand Down
6 changes: 6 additions & 0 deletions debian/changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
timetabler (0.2.0-1ubuntu1) bionic; urgency=medium

* Initial release for bionic

-- Prateek Kumar <[email protected]> Mon, 13 Aug 2018 22:35:09 +0530

timetabler (0.2.0-1) xenial; urgency=medium

* Initial release
Expand Down
2 changes: 1 addition & 1 deletion debian/files
Original file line number Diff line number Diff line change
@@ -1 +1 @@
timetabler_0.2.0-1_source.buildinfo devel optional
timetabler_0.2.0-1ubuntu1_source.buildinfo devel optional

0 comments on commit 05d66a9

Please sign in to comment.