Add documentation of high-level design decisions.

Just to keep track of them.

Change-Id: I457fd91f03314454bb98d0d5b2a6ef37cca26b18
Reviewed-on: https://fuchsia-review.googlesource.com/c/shac-project/shac/+/868883
Reviewed-by: Oliver Newman <olivernewman@google.com>
Commit-Queue: Eli Ribble <eliribble@google.com>
2 files changed
tree: 3015821d36eff19d3157ec73025823b7279aa658
  1. .github/
  2. doc/
  3. images/
  4. internal/
  5. scripts/
  6. .gitignore
  7. AUTHORS
  8. check_doc.star
  9. codecov.yml
  10. CONTRIBUTING.md
  11. go.mod
  12. go.star
  13. go.sum
  14. LICENSE
  15. licenses.star
  16. main.go
  17. OWNERS
  18. PATENTS
  19. README.md
  20. shac.star
  21. shac.textproto
README.md

shac

Shac (Scalable Hermetic Analysis and Checks) is a unified and ergonomic tool and framework for writing and running static analysis checks.

Shac checks are written in Starlark.

usage demonstration

Usage

go install go.fuchsia.dev/shac-project/shac@latest
shac check
shac doc shac.star | less

Documentation

Contributing

⚠ The source of truth is at https://fuchsia.googlesource.com/shac-project/shac.git and uses Gerrit for code review.

See CONTRIBUTING.md to submit changes.