replica
/
diffblue-cbmc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
diffblue-cbmc/README.md

65 lines
2.9 KiB
Markdown
Raw Normal View History

Remove appveyor badge
2018-07-17 20:41:10 +08:00
[![Build Status][travis_img]][travis]
Add AWS CodeBuild badges
2018-07-17 21:02:07 +08:00
![Build Status][codebuild_img]
![Build Status][codebuild_windows_img]
Add Coverity scan Coverity scan will run as separate job in second stage. Ii will terminate itself as soon as possible if build is not triggered by cron. Therefore it requires to have cron job setup in settings of diffblue/cbmc and environment variable `COVERITY_SCAN_TOKEN` in the same project settings.
2017-08-30 20:30:59 +08:00
[![Build Status][coverity_img]][coverity]
Add codecov badge
2019-05-30 16:44:45 +08:00
[![Build Status][codecov_img]][codecov]
Initial README.md, including Travis-CI configuration git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6531 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-03-19 20:16:25 +08:00
fixed travis links in README.md git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6533 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-03-21 07:27:33 +08:00
[CProver Wiki](http://www.cprover.org/wiki)
Add online documentation to README
2018-03-23 07:19:52 +08:00
[CProver Documentation](http://cprover.diffblue.com)
Initial README.md, including Travis-CI configuration git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6531 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-03-19 20:16:25 +08:00
About
=====
CBMC is a Bounded Model Checker for C and C++ programs. It supports C89, C99,
most of C11 and most compiler extensions provided by gcc and Visual Studio. It
also supports SystemC using Scoot. It allows verifying array bounds (buffer
overflows), pointer safety, exceptions and user-specified assertions.
Furthermore, it can check C and C++ for consistency with other languages, such
as Verilog. The verification is performed by unwinding the loops in the program
and passing the resulting equation to a decision procedure.
For full information see [cprover.org](http://www.cprover.org/cbmc).
Contributing section in readme
2017-08-22 22:38:28 +08:00
Versions
========
Get the [latest release](https://github.com/diffblue/cbmc/releases)
* Releases are tested and for production use.
Get the current *develop* version: `git clone https://github.com/diffblue/cbmc.git`
* Develop versions are not recommended for production use.
Report bugs
===========
If you encounter a problem please file a bug report:
* Create an [issue](https://github.com/diffblue/cbmc/issues)
Contributing to the code base
=============================
1. Fork the repository
2. Clone the repository `git clone git@github.com:YOURNAME/cbmc.git`
3. Create a branch from the `develop` branch (default branch)
4. Make your changes (follow the [coding guidelines](https://github.com/diffblue/cbmc/blob/develop/CODING_STANDARD.md))
5. Push your changes to your branch
6. Create a Pull Request targeting the `develop` branch
Add CBMC Mini Projects list This list is intended to be a central repository of small, focussed CBMC 'nice-to-have' features that would be suitable for first-time CBMC contributors to get their feet wet with. Projects on this list should have the following features: - Small (e.g. <200 LOC) or easy to implement - This is so that time-constrained contributors (like interns or students) can use these projects to ramp up before starting their main CBMC work - Focussed, touching only one part of the codebase - This is so that people wanting to learn about one aspect of CBMC (solver, front-end, symex) can pick a project that involves that part of the codebase. - Genuinely useful to somebody - This is so that somebody will be keen to quickly review and merge the code, and guide the new contributor in polishing the PR. This leads to a more rewarding experience for the contributor.
2019-01-23 03:54:28 +08:00
New contributors can look through the [mini
projects](https://github.com/diffblue/cbmc/blob/develop/MINI-PROJECTS.md)
page for small, focussed feature ideas.
Initial README.md, including Travis-CI configuration git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6531 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-03-19 20:16:25 +08:00
License
=======
4-clause BSD license, see `LICENSE` file.
fixed travis links in README.md git-svn-id: svn+ssh://svn.cprover.org/srv/svn/cbmc/trunk@6533 6afb6bc1-c8e4-404c-8f48-9ae832c5b171
2016-03-21 07:27:33 +08:00
[travis]: https://travis-ci.org/diffblue/cbmc
Adding build icon for AppVeyor
2017-04-07 00:16:56 +08:00
[travis_img]: https://travis-ci.org/diffblue/cbmc.svg?branch=master
Update Codebuild badge
2019-03-25 20:07:51 +08:00
[codebuild_img]: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiajhxcmNGUEgyV0xZa2ZFaVd3czJmbm1DdEt3QVdJRVdZaGJuMTUwOHFrZUM3eERwS1g4VEQ3Ymw3bmFncldVQXArajlYL1pXbGZNVTdXdndzUHU4Ly9JPSIsIml2UGFyYW1ldGVyU3BlYyI6IkVUUEdWVEt0SUFONlhyNVAiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=develop
Add AWS CodeBuild badges
2018-07-17 21:02:07 +08:00
[codebuild_windows_img]: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTFQ4Q0lCSEc1Rk5NcmlzaFZDdU44Vk8zY0c1VCtIVWMwWnJMRitmVFI5bE94Q3dhekVPMWRobFU2Q0xTTlpDSWZUQ3J1eksrWW1rSll1OExXdll2bExZPSIsIml2UGFyYW1ldGVyU3BlYyI6InpqcloyaEdxbjBiQUtvNysiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=develop
Add Coverity scan Coverity scan will run as separate job in second stage. Ii will terminate itself as soon as possible if build is not triggered by cron. Therefore it requires to have cron job setup in settings of diffblue/cbmc and environment variable `COVERITY_SCAN_TOKEN` in the same project settings.
2017-08-30 20:30:59 +08:00
[coverity]: https://scan.coverity.com/projects/diffblue-cbmc
[coverity_img]: https://scan.coverity.com/projects/13552/badge.svg
Add codecov badge
2019-05-30 16:44:45 +08:00
[codecov]: https://codecov.io/gh/diffblue/cbmc
[codecov_img]: https://codecov.io/gh/diffblue/cbmc/branch/develop/graphs/badge.svg