longjohncoder / acl2

ACL2 System and Books as Maintained by the Community

ACL2 System and Community Books

WARNING: On rare occasions development versions of ACL2 may be incomplete, fragile, or unable to pass the usual regression tests. You may choose to download an official ACL2 release as described on the ACL2 Home Page or below in this README.

The ACL2 theorem proving environment consists of two parts: The ACL2 System and The ACL2 Books. This repository contains both.

ACL2 System

The included version of the ACL2 System is the latest, under-development version of the ACL2 Theorem Prover. It is updated only by the ACL2 authors, Matt Kaufmann and J Moore.

ACL2 Books

The books/ directory of this repository comprises the Community Books, which are the canonical collection of open-source libraries for the ACL2 System. As the name suggests, they are updated by the ACL2 community.

Documentation

• The Combined ACL2 + Books Manual has extensive documentation for the latest stable version of ACL2 and many of the community books that come with it.

• There is also a development version of the manual which is updated reasonably frequently and corresponds to the development version of ACL2 and its books.

• Finally there is the more compact ACL2-only manual which only documents the ACL2 system itself and not any books.

Each of these manuals can be downloaded for offline use by clicking the download button on the right hand side of the upper toolbar while browsing the manual.

Obtaining the Source Code

While active development of ACL2 occurs at the acl2/acl2 repo on GitHub, stable releases are officially distributed from the acl2-devel/acl2-devel fork, which exists for that purpose.

Latest Stable Release

You can download a gzipped tarfile or zip file for the latest release, which includes the ACL2 system and the community books, from the releases page on GitHub.

Alternatively you can obtain a copy of the latest release using git. Do the following, after changing /path/to/somewhere/ to some suitable path where the directory /path/to/somewhere/acl2/ does not already exist.

git clone -b 8.0 git://github.com/acl2-devel/acl2-devel.git /path/to/somewhere/acl2/

The new directory /path/to/somewhere/acl2/ will now contain a copy of ACL2 Version 8.0. Please see the ACL2 home page, specifically its installation instructions, for how to build an executable and certify books in your new directory.

Experimental Development Version

To check out the latest development version of the repository using git, do the following:

git clone git://github.com/acl2/acl2.git

Contributing

See the documentation for how to contribute.

Even though we have merged the Community Books (formerly acl2-books) and ACL2 System (formerly acl2-devel) repositories into one, changes should be made only to the books/ subdirectory unless you are Matt Kaufmann or J Moore, since everything outside books/ is part of the ACL2 system. (If you have suggestions for system changes, they should be emailed to Matt or J, as has been done in the past.)

Staying Informed

We invite anyone who is using this repository to join the acl2-books mailing list, which receives commit messages and other discussion related to ACL2 system- and book-related development.

Contributors wanted!

Everyone can contribute documentation and advice to our wiki and discuss problems and feature requests.

If you would like to contribute to this repository, see the documentation topic git-quick-start. Please note the guidelines for book development.