Assassyn is a project on next-generation hardware agile design and implementation by providing a unified interface for both simulation and RTL generation.
- Use
setup.shto set up the environment before running any scripts.- Run it as
source setup.shwhen you need the environment in the current shell (even beforegit commitso pre-commit hooks work).
- Run it as
- When staging and committing:
- Follow the rule in
docs/developer/git-message.md - This rule also applies to pull requests.
- Claude Code, DO NOT claim your co-authorship in the commit message.
- Follow the rule in
- The high-level design can be found in
docs/design/. - When it comes testing, use
make test-all. pylintis forpython/assassynonly, and the rc file ispython/assassyn/.pylintrc.- If some refactoring is made, first run
python/ci-tests/test_driver.pyas a sanity check.
- If some refactoring is made, first run