https://github.com/egraphs-good/eggcc

https://github.com/egraphs-good/eggcc

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/egraphs-good/eggcc
• Owner: egraphs-good
• License: mit
• Created: 2023-07-10T16:47:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T23:36:44.000Z (about 2 months ago)
• Last Synced: 2024-10-29T23:39:59.501Z (about 2 months ago)
• Language: Rust
• Size: 33.6 MB
• Stars: 49
• Watchers: 6
• Forks: 10
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-egraphs - eggcc

README

        
# eggcc

## Installation

- [Install rust](https://www.rust-lang.org/tools/install)

- Clone the repo

- Install the `insta` command for `cargo`

  ```

  cargo install cargo-insta

  ```

- Install `graphviz` on your system. You'll need a `dot` executable in your path.

## Installation- Mac

- Install llvm 18 with `brew install llvm@18`  

  - If you get an error with this step, try upgrading MacOS to at least Sonoma (14)

- Add llvm to PATH in your `.zshrc` file: `export PATH="/opt/homebrew/Cellar/llvm@18/18.1.8/bin/:$PATH"`

- Open a new terminal (`source`ing alone may not work).

- Run `make runtime` to install the bril llvm runtime. If this fails, try running `cargo clean` in `runtime` and trying again.

- You may need to add LSystem to your path: `export LIBRARY_PATH="$LIBRARY_PATH:/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/lib"`

- Run the tests with `make` and ensure things build and run without errors.

- On Mac running `make` might show this error: `Library not loaded: /opt/homebrew/opt/icu4c/lib/libicui18n.74.dylib`. To resolve this, run `brew upgrade` and `brew cleanup`.

  - Warning: this updates all your brew packages

- On Mac, if you get a linker error complaining about not being able to find

  zstd, try adding zstd to your `LIBRARY_PATH` in `.zshrc` or `.zprofile`, e.g: `export LIBRARY_PATH="$LIBRARY_PATH:/opt/homebrew/opt/zstd/lib"`

## Installation- Linux

- Install llvm 18. For Ubuntu users, we have a script for installation: `./install_ubuntu.sh`

- Run `make runtime` to install the bril llvm runtime.

- Run the tests with `make` and ensure things build and run without errors.

## How to add a test

- Add a bril file under `tests/`.

- Run `cargo insta review` to confirm the output for the new file.

## How to run local nightly

- Run `bash infra/localnightly.sh `

To run the nightly server for an existing nightly, run `cd nightly/output && python3 -m http.server`.