berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

cargo: toggle `disable_contracts` feature on by default

This commit is contained in:
Mikolaj Wielgus 2024-07-15 00:39:37 +02:00
parent 08c444d16d
commit 925e3d5266
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -64,11 +64,11 @@ Change your working directory to your clone of Topola's repository:
Build the project with Build the project with
cargo build --features "egui,disable_contracts" --bin topola-egui cargo build --features egui --bin topola-egui
Finally, run Topola by executing Finally, run Topola by executing
cargo run --features "egui,disable_contracts" --bin topola-egui cargo run --features egui --bin topola-egui
##### Running Topola in a Web browser ##### Running Topola in a Web browser
@ -87,18 +87,17 @@ To build and open Topola in your browser, run
Optionally, for shorter build times you may build the SDL2 demo instead Optionally, for shorter build times you may build the SDL2 demo instead
of the Egui port: of the Egui port:
cargo build --features sdl2 --bin topola-sdl2-demo cargo build --features sdl2 --bin topola-sdl2-demo
cargo run --features sdl2 --bin topola-sdl2-demo cargo run --features sdl2 --bin topola-sdl2-demo
The downside is that the SDL2 demo's user interface is highly incomplete. The downside is that the SDL2 demo's user interface is highly incomplete.
#### Automated tests #### Automated tests
Topola has automated tests to make sure its basic functionalities work. Topola has automated tests to make sure its basic functionalities work.
To execute these, run To execute these, run
cargo test --features disable_contracts cargo test
#### Contracts #### Contracts
@ -130,7 +129,13 @@ You can go back to stable with
##### Enabling contracts ##### Enabling contracts
To enable contracts, simply remove the `disable_contracts` feature from To enable contracts, simply add a `--no-default-features` switch. This
commands. For example, to build tests with contracts, simply run switches off a default feature that prevents contracts from executing.
For example, to build tests with contracts, simply run
cargo test cargo test --no-default-features
Of course, you can enable contracts for any build target. For example,
the following command will build the Egui port with contracts enabled:
cargo build --features egui --bin topola-egui --no-default-features

1
Cargo.toml
View File

@ -21,6 +21,7 @@ name = "topola-sdl2-demo"
required-features = ["sdl2"] required-features = ["sdl2"]
[features] [features]
default = ["disable_contracts"]
cli = ["dep:clap"] cli = ["dep:clap"]
egui = ["dep:eframe", "dep:egui", "dep:rfd", "dep:futures"] egui = ["dep:eframe", "dep:egui", "dep:rfd", "dep:futures"]
sdl2 = ["dep:sdl2", "dep:gl", "dep:pathfinder_canvas", "dep:pathfinder_geometry", "dep:pathfinder_gl", "dep:pathfinder_renderer", "dep:pathfinder_resources"] sdl2 = ["dep:sdl2", "dep:gl", "dep:pathfinder_canvas", "dep:pathfinder_geometry", "dep:pathfinder_gl", "dep:pathfinder_renderer", "dep:pathfinder_resources"]