From 41d335b8aaa1db8c19e9798bb4b9a2bd601b6988 Mon Sep 17 00:00:00 2001 From: Kartik Singhal Date: Mon, 11 Nov 2024 14:28:08 -0600 Subject: [PATCH] chore: update more of the notes --- DEVELOPMENT.md | 4 ++-- README.md | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index f12dc83..b62d816 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -46,7 +46,7 @@ We use `rustfmt` to enforce a consistent coding style. The CI will fail if the c To format your code, run: ```bash -cargo format +cargo fmt ``` We also use various linters to catch common mistakes and enforce best practices. To run these, see [our CI config](./.github/workflows/ci-rs.yml). TODO Provide a better way, contributions welcome. @@ -66,7 +66,7 @@ cargo install cargo-llvm-cov Then run the tests, see [our CI config](/.github/workflows/ci-rs.yml). ```bash -just coverage +cargo llvm-cov --lcov --output-path lcov.info ``` This will generate a coverage file that can be opened with your favourite coverage viewer. In VSCode, you can use diff --git a/README.md b/README.md index 2b8f512..d4d5dd8 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,3 @@ This project is licensed under Apache License, Version 2.0 ([LICENCE](LICENCE) o [inkwell]: https://thedan64.github.io/inkwell/inkwell/index.html [llvm-sys]: https://crates.io/crates/llvm-sys [llvm]: https://llvm.org/ - [guppy]: https://github.com/CQCL/guppylang