Merge pull request #5 from jeandersonbc/readme-update
[jpf-core.git] / README.md
1 # Java PathFinder
2
3 An extensible software model checking framework for Java bytecode programs
4
5 ## General Information about JPF
6
7 All the latest developments, changes, documentation can be found on our
8 [wiki](https://github.com/javapathfinder/jpf-core/wiki) page.
9
10 ## Building and Installing
11
12 If you are having problems installing and running JPF, please look at the [How
13 to install
14 JPF](https://github.com/javapathfinder/jpf-core/wiki/How-to-install-JPF) guide.
15
16
17 We have documented on the wiki a lot of common problems during the install and
18 build processes reported by users.  If you are facing any issue, please, make
19 sure that we have not addressed it in documentation. Otherwise, feel free to
20 contact us at java-pathfinder@googlegroups.com or open an issue on the Issue
21 Tracker.
22
23 ## Documentation
24
25 There is a constant effort to update and add JPF documentation on the wiki.
26 If you would like to contribute in that, please, contact us at
27 java-pathfinder@googlegroups.com.
28
29 Contributions are welcomed and we encourage you to get involved with the
30 community.
31
32 Happy Verification
33 *-- the Java PathFinder team*