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

Docker images: Document supported entrypoints #1264

Open
RyanGlScott opened this issue Oct 17, 2024 · 0 comments
Open

Docker images: Document supported entrypoints #1264

RyanGlScott opened this issue Oct 17, 2024 · 0 comments
Labels
Docker Issues relating to the Docker images. documentation

Comments

@RyanGlScott
Copy link
Contributor

The crux-llvm and crux-mir Docker images currently use the crux-llvm command and the cargo crux-test command as their respective entrypoints. However, these are not the only ways of using the Docker images:

  • In both images, one can use a shell (e.g., bash) to use the images interactively.
  • For the crux-mir image, one can use other commands such as crux-mir, cargo saw-build, crux-rustc, saw-rustc, etc.

We should document all of the alternative entrypoints that we support, along with examples of how to invoke them, what their command-line options are, and other relevant information.

@RyanGlScott RyanGlScott added documentation Docker Issues relating to the Docker images. labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docker Issues relating to the Docker images. documentation
Projects
None yet
Development

No branches or pull requests

1 participant