Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
marcbenedi committed Dec 27, 2018
1 parent a4819d6 commit 6cf7c34
Showing 1 changed file with 59 additions and 12 deletions.
71 changes: 59 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,39 @@

This project is an environment to work with Pseudo-Boolean optimisation problems and Boolean formulae.

## Example
## Code example
```cpp
Formula a = BoolFunc::newLit("a");
Formula b = BoolFunc::newLit("b");

Formula c = a + b;
Cnf tseitin = CnfConverter::tseitin(c);
tseitin.print();
```

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

## Table of contents
* Installation
* Usage
* Built With
* Contributing
* Versioning
* Authors
* License
* Acknowledgments

### Prerequisites
## Installation

For installing and running, there are two requisites:
* [cmake](https://cmake.org/install/)
* [picosat](http://fmv.jku.at/picosat/)
* [minisat](http://minisat.se/)
* [zlib1g-dev](https://packages.debian.org/search?keywords=zlib1g-dev)
### Requirements

For installing and running, there are four requirements. **This must be present in the system:**
* **[cmake](https://cmake.org/install/):** CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice.
* **[picosat](http://fmv.jku.at/picosat/):** A SAT solvers
* **[minisat](http://minisat.se/):** A SAT solver
* **[zlib1g-dev](https://packages.debian.org/search?keywords=zlib1g-dev):** zlib is a library implementing the deflate compression method found in gzip and PKZIP

The first three need to be accessible through the cml:
```sh
Expand All @@ -23,7 +43,7 @@ $ cmake --version
$ minisat
```

### Installing
### How to download it and install it

Download the project.
It is recommended to download always stable versions:
Expand All @@ -38,14 +58,17 @@ To install this project execute:
$ chmod +x installer.sh
$ ./installer.sh
```
This script will install all the required things:
This script will install the following libraries:
* [Google Test](https://github.com/google/googletest)
* [PBLib](http://tools.computational-logic.org/content/pblib.php)
* [Cudd](https://github.com/ivmai/cudd)

Finally, it will execute the tests.

## Compile a file
## Usage

Check the [Wiki page](https://github.com/marcbenedi/SAT-tfg/wiki).


## Built With

Expand All @@ -60,17 +83,41 @@ Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c6
## Versioning

For the versions available, see the [tags on this repository](https://github.com/marcbenedi/SAT-tfg/tags).
It is always recommended to use the latest version.

## Authors
* **[Jordi Cortadella](https://www.cs.upc.edu/~jordicf/)** - *Original idea and supervisor*
* **[Marc Benedí](http://marcb.pro/)** - *Creator*
* **[Marc Benedí](http://marcb.pro/)** - *Author and developer*

See also the list of [contributors](https://github.com/marcbenedi/SAT-tfg/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

```
MIT License
Copyright (c) 2018 Marc Benedí
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Acknowledgments

* [Jordi Cortadella](https://www.cs.upc.edu/~jordicf/)

0 comments on commit 6cf7c34

Please sign in to comment.