Editing main.jpf

[jpf-core.git] / README.md

diff --git a/README.md b/README.md
index 47ebe4abf36ffe0a9b6c4186c6dd5a2d5dced979..8272a80860e3c642f440935dd88cca845504ba2c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,34 @@
-# jpf-core
-This is the basis for all JPF projects, i.e. you always need to install it. jpf-core contains the basic VM and model checking infrastructure, and can be used to check for concurrency defects like deadlocks, and unhandled exceptions like NullPointerExceptions and AssertionErrors.
+# Java PathFinder
+[![Build Status](https://travis-ci.org/javapathfinder/jpf-core.svg?branch=master)](https://travis-ci.org/javapathfinder/jpf-core)
+
+An extensible software model checking framework for Java bytecode programs
+
+## General Information about JPF
+
+All the latest developments, changes, documentation can be found on our
+[wiki](https://github.com/javapathfinder/jpf-core/wiki) page.
+
+## Building and Installing
+
+If you are having problems installing and running JPF, please look at the [How
+to install
+JPF](https://github.com/javapathfinder/jpf-core/wiki/How-to-install-JPF) guide.
+
+
+We have documented on the wiki a lot of common problems during the install and
+build processes reported by users.  If you are facing any issue, please, make
+sure that we have not addressed it in documentation. Otherwise, feel free to
+contact us at java-pathfinder@googlegroups.com or open an issue on the Issue
+Tracker.
+
+## Documentation
+
+There is a constant effort to update and add JPF documentation on the wiki.
+If you would like to contribute in that, please, contact us at
+java-pathfinder@googlegroups.com.
+
+Contributions are welcomed and we encourage you to get involved with the
+community.
+
+Happy Verification
+*-- the Java PathFinder team*