Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Filament docs #301

Open
gabizon103 opened this issue Sep 1, 2023 · 3 comments
Open

Update Filament docs #301

gabizon103 opened this issue Sep 1, 2023 · 3 comments
Labels
C: docs Documentation S: available This is available to be worked on

Comments

@gabizon103
Copy link
Collaborator

On the Getting Started page it says to configure fud with cargo build && fud config stages.futil.exec "$(pwd)/target/debug/futil". This should be changed to cargo build && fud config stages.calyx.exec "$(pwd)/target/debug/calyx"

Also, syntax highlighting is not mentioned, but should probably be included. For VS Code:

cd $HOME/.vscode/extensions
ln -s <filament root directory>/tools/vscode filament.filament-0.0.1
@rachitnigam
Copy link
Member

Thanks for finding this! In fact, the calyx configuration is probably no longer needed because we invoke the calyx compiler ourselves but reasonable to update it anyways!

@rachitnigam rachitnigam added the C: docs Documentation label Sep 2, 2023
@rachitnigam rachitnigam added the S: available This is available to be worked on label Sep 22, 2023
@CrepeGoat
Copy link

CrepeGoat commented Aug 24, 2024

related?: the "getting started" page says to run cargo run -- tests/compile/par.fil to test the build.

I get a few errors:

$ cargo run -- ./tests/compile/par.fil
error: `cargo run` could not determine which binary to run. Use the `--bin` option to specify a binary, or the `default-run` manifest key.
available binaries: fil-gen, filament
$ cargo run --bin=filament -- ./tests/compile/par.fil
warning: ...
warning: ...

Error: invalid file: Failed to read ./tests/compile/par.fil: No such file or directory (os error 2): 
Compilation failed with 1 errors.
Run with --show-models to generate assignments for failing constraints.

I can't find a file named ./tests/compile/par.fil either. so it seems that the docs should:

  1. include the --bin=filament flag, and
  2. list a working test file

@CrepeGoat
Copy link

related?: the "getting started" page says to run cargo run -- tests/compile/par.fil to test the build.

I get a few errors:
...

moved ^that request to a new issue: #451

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: docs Documentation S: available This is available to be worked on
Projects
None yet
Development

No branches or pull requests

3 participants