On Windows some characters won't show correctly in the CLI to fix this you can follow this post (does not work for my Win10 Laptop idk)
- See #38
- See #34
- See #23
- See #22
- some simple tests
- Board
- CLI interactions
- print board
- reveal squares and propagate through field until bombs are nearby
- working bombs
- flag squares
Run the main file:
effekt src/main.effekt
This (like many other Effekt commands) uses the JavaScript backend by default.
To use a different backend, add the --backend <backend>
flag.
Run the tests:
effekt src/test.effekt
Open the REPL:
effekt
Build the project:
effekt --build src/main.effekt
This builds the project into the out/
directory, creating a runnable file out/main
.
To see all available options and backends, run:
effekt --help
While Nix installation is optional, it provides several benefits:
Update dependencies (also runs automatically in CI):
nix flake update
Open a shell with all necessary dependencies:
nix develop
Run the main entry point:
nix run
Build the project (output in result/bin/
):
nix build
effekt-stm
- This very project!
.github/workflows/*.yml
: Contains the CI definitionssrc/
: Contains the source codemain.effekt
: Main entry pointtest.effekt
: Entry point for testslib.effekt
: Library code imported bymain
andtest
flake.nix
: Package configuration in a Nix flakeflake.lock
: Auto-generated lockfile for dependenciesLICENSE
: Project licenseREADME
: This README file
Two GitHub Actions are set up:
-
flake-check
:- Checks the
flake.nix
file, builds and tests the project - Runs on demand, on
main
, and on PRs - To run custom commands, add a step using:
nix run -- <ARGS>
to run the main entry point with the given argumentsnix develop -c '<bash command to run>'
to run commands in the correct environment
- Checks the
-
update-flake-lock
:- Updates package versions in
flake.nix
- Runs on demand and weekly (Tuesdays at 00:00 UTC)
- Updates package versions in