• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • Proof-automation
    • ACL2
      • Theories
      • Rule-classes
      • Proof-builder
      • Recursion-and-induction
      • Hons-and-memoization
      • Events
      • Parallelism
      • History
      • Programming
      • Operational-semantics
      • Real
      • Start-here
        • Gentle-introduction-to-ACL2-programming
        • ACL2-tutorial
        • About-ACL2
          • Recursion-and-induction
          • Operational-semantics
          • Soundness
          • Release-notes
          • Version
          • Acknowledgments
          • Pre-built-binary-distributions
          • How-to-contribute
          • Common-lisp
          • Git-quick-start
            • Github-commit-code-using-push
            • Github-commit-code-using-pull-requests
          • Copyright
          • Building-ACL2
          • ACL2-help
          • Bibliography
      • Debugging
      • Miscellaneous
      • Output-controls
      • Macros
      • Mailing-lists
      • Interfacing-tools
    • Macro-libraries
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
    • Math
    • Testing-utilities
  • About-ACL2

Git-quick-start

Git quick start guide.

The ACL2 GitHub repository contains the ``bleeding edge'' ACL2 source code and community-books, available between ACL2 releases.

Here we provide minimal instructions for working with the ACL2 GitHub repo. Many git tutorials are available elsewhere on the web (e.g., at GitHub).

For non-contributors (to use ACL2 without contributing changes):

Start by obtaining the ACL2 GitHub repository (this command makes a directory called acl2 that contains the current contents of the master branch):

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

Later, to update your copy to get the latest changes:

cd acl2
git pull

Once you have ACL2, you will probably want to certify some books (see books-certification).

For infrequent contributors:

For those only planning on contributing a few times per year (or less), see github-commit-code-using-pull-requests.

For frequent contributors:

For those contributing on a monthly or weekly basis, see github-commit-code-using-push.

Subtopics

Github-commit-code-using-push
How to commit code to the books using direct push access
Github-commit-code-using-pull-requests
How to commit code to the books using pull requests