Where-do-i-place-my-book
How to decide where in the books directory structure to place your book
Here is our loose view of the books organization:
- project-specific stuff
- useful libraries not yet vetted by the 'std' maintainers
- libraries 'approved' for the standard approach
Books in category (1) easily belong in books/projects.
Books in category (2) can go in the top-level books directory or in
projects. There's so much stuff in the top-level directory, that we suggest
books/projects -- especially for people that are new to the ACL2
community.
Once general-use books are vetted by the ACL2 book Czars, they go in the
std directory. Some of the criteria the book czars use to decide
whether a book should be in std follow below:
- Design is consistent with other std books
- Has some general purpose use -- e.g., data structure books are very
much something that you would expect to see in a general framework for a
language like Java
- Has good documentation that explains how to use it
