Fun issues noticed during Hackathon
- Dominant language
- MLIR
- Stars
- 906
- Forks
- 171
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 32
Description
* FIrst part of getting started is still wget heir-opt, we probably want to refer to pip install instead and drop that
* We tell people to download something and RENAME IT TO "bazel" but WE HAVE A FOLDER NAMED "bazel" in our repo so they nuke the bazel dir, which means bazel build doesn't work xD
* On Mac, tell peple to NOT install brew bazel, they need brew bazel**isk**: If you already have bazel , first brew uninstall bazel, then brew install bazelisk
* Make it clear what's developer documentation and what isn't (especially for python frontend)
* On Mac, if you install bazelisk, you'll need to call `bazelisk` (as opposed to `bazel`)
* Xcode full: we should add some screenshots with appstore instructions
* Probably make the "Detailed instructions" for bazel/etc not need to be folded out
* Tutorial has a somewhat arcane bazel build command with no-yosys/etc. Probabl easier to just make people to bazel build //...
* Should also add a few steps on how to add python venv
* Building heir-opt builds OpenFHE but not necessarily the shared version we need for frontend
* Add a note to e2e_test.py to redirect people to example.py instead
* Tell people to do `pip install -e .` in heir directory so they can do `python frontend/example.py` instead of `python -m frontend.example`
* Example on what is a conversion vs transform
Contributor guide
Assessment
This issue has not been assessed yet.