improve the readme for new users. #191
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zoep
requested changes
Apr 2, 2025
README.md
Outdated
|
|
||
| ```sh | ||
| nix build | ||
| ``` | ||
|
|
||
| # Developing | ||
|
|
||
| Enter a nix-shell to get the dependencies of the project: | ||
| After building, enter a nix-shell to get the dependencies of the project: |
There was a problem hiding this comment.
You don't have to build to enter a nix-shell
README.md
Outdated
|
|
||
| ```sh | ||
| nix develop | ||
| ``` | ||
|
|
||
| you can then use `cabal` as normal: | ||
| you can then use `cabal` as normal from where you have `act.cabal`, could be in `./src`: |
There was a problem hiding this comment.
act.cabal is at the root directory of act and it won't move (unless we move it).
| ``` | ||
|
|
||
| To update the project dependencies run: | ||
|
|
||
| ```sh | ||
| nix flake update | ||
| ``` | ||
|
|
||
| # Usage |
There was a problem hiding this comment.
There is also a --help option for each one of them that describes all the available command line options.
README.md
Outdated
| ## SMT | ||
|
|
||
| ```sh | ||
| act prove --file <PATH_TO_SPEC> |
There was a problem hiding this comment.
Being able to use the act executable relies on having run make first, as it is the Makefile that runs the command to build it (of course one could also run it by hand).
I suggest using cabal run act instead which has no prerequisites, or specifying that make has to be run first.
|
The readme and the docs are now updated according to Zoe's suggestions. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I had some issues at first to set up act on my machine, so I updated the readme a bit to match the current state of the repository.