Skip to content

Commit

Permalink
Updated readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
hajduakos committed Sep 13, 2017
1 parent 038ab0a commit d957aca
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,21 @@

[![Build Status](https://travis-ci.com/FTSRG/theta-dev.svg?token=85GYo3nhkE5uMJYayyw8&branch=master)](https://travis-ci.com/FTSRG/theta-dev)

## About

_Theta_ is a generic, modular and configurable model checking framework developed at the [Fault Tolerant Systems Research Group](http://inf.mit.bme.hu/en) of [Budapest University of Technology and Economics](http://www.bme.hu/?language=en), aiming to support the design and evaluation of abstraction refinement-based algorithms for the reachability analysis of various formalisms.
The main distinguishing characteristic of Theta is its architecture that allows the definition of input formalisms with higher level language front-ends, and the combination of various abstract domains, interpreters, and strategies for abstraction and refinement.
The main distinguishing characteristic of Theta is its architecture that allows the definition of input formalisms with higher level language front-ends, and the combination of various abstract domains, interpreters, and strategies for abstraction and refinement. If you want to read more, take a look at the [list of publications](http://home.mit.bme.hu/~hajdua/theta/).

## Get Theta

* Clone the repository.
* Build the projects from the command line by executing `gradlew.bat build` (Windows) or `./gradlew build` (Linux) from the root directory.
* On Windows, some libraries are required from the [Microsoft Visual C++ Redistributable package](https://www.microsoft.com/en-us/download/details.aspx?id=48145). Install it, or just go into the `lib` folder and execute `Download-VCredist.ps1`, which will download the required libraries.

## Use Theta

If you want to use the existing algorithms and tools defined in Theta, then take look at [doc/Tools.md](doc/Tools.md).

## Extend Theta

For more information, see the [list of publications](http://home.mit.bme.hu/~hajdua/theta/) and the [doc](doc) folder.
If you want to extend Theta and build your own algorithms and tools, then take look at [doc/For-developers.md](doc/For-developers.md), [doc/Architecture.md](doc/Architecture.md) and [Coding-conventions.md](doc/Coding-conventions.md).
3 changes: 0 additions & 3 deletions doc/For-developers.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ As the main repository is read-only, we suggest you to create your own [fork](ht

As the framework is under development, we suggest you to [sync your fork](https://help.github.com/articles/syncing-a-fork/) often and merge the master branch into your development branch(es).

## Building from the command line
Thanks to the Gradle Wrapper, no installation is required. The projects can be simply built from the command line by executing `gradlew.bat build` (Windows) or `./gradlew build` (Linux) from the root directory.

## Importing and developing in Eclipse

The projects are currently developed and tested with [Oxygen](https://www.eclipse.org/oxygen/).
Expand Down
8 changes: 0 additions & 8 deletions doc/README.md

This file was deleted.

0 comments on commit d957aca

Please sign in to comment.