Skip to content

Commit 9529324

Browse files
committed
wip: refactor(tweaker): revamp tweak tool in Rust
1 parent 578800e commit 9529324

2 files changed

Lines changed: 4 additions & 6 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When building a package for distribution, please ensure the following:
1313
```
1414
The resulting binary will be located at `target/release/linux-enable-ir-emitter`. You can also use `cargo install --path <...>` to your convenience.
1515
4. The v7 is incompatible with the v6. If applicable, please make sure to use the provided [migration script]() on the saved configuration.
16-
> [!Important]
16+
> [!IMPORTANT]
1717
> This script is not yet available. It will be provided when the v7 will be officially released (currently in beta).
1818
1919
## Contributing Code
@@ -24,10 +24,8 @@ This project is using the usual Rust conventions. Here are some additional expla
2424
cargo build
2525
```
2626
The resulting binary will be located at `target/debug/linux-enable-ir-emitter`
27-
2827
> [!NOTE]
2928
> With a debug build, any camera can be used, even not infrared ones. This is useful for development and testing.
30-
3129
2. Add the pre-commit hooks to make sure the linting checks and tests are passing before each commit:
3230
```
3331
git config core.hooksPath .githooks

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,15 @@ auth optional pam_exec.so /home/<USER>/.local/bin/linux-enable-ir-emitter run --
3535
```
3636

3737
> [!TIP]
38-
> The installation paths may vary depending on your installation method. You can determine the correct binary absolute paths by running `which linux-enable-ir-emitter` and use that path instead. For the configuration path, it will be written when you can execute `linux-enable-ir-emitter --config`.
38+
> The installation path may vary depending on your installation method. You can determine the correct binary absolute path by running `which linux-enable-ir-emitter` and use it instead. For the configuration path, it will be written when you execute `linux-enable-ir-emitter --config`.
3939
4040
### Integration with other program
4141
You will need to execute the `linux-enable-ir-emitter run` command before the program that uses the infrared camera.
4242

4343
Alternatively, if you can and/or want to integrate better with the program that uses the camera, you can pass an opened file descriptor for the camera to the command: `linux-enable-ir-emitter run --device <DEVICE> --fd <FD>`.
4444

45-
> [!Important]
46-
> You will need to pass the config path as argument to `linux-enable-ir-emitter run --config <CONFIG_PATH>` **when executed as root** if `linux-enable-ir-emitter configure` was executed as a normal user.
45+
> [!IMPORTANT]
46+
> You will need to pass the config path as argument to `linux-enable-ir-emitter run --config <CONFIG_PATH>` **when executed as root**, if `linux-enable-ir-emitter configure` was executed as a normal user.
4747
4848
## How do I enable my infrared emitter?
4949
0. For a better experience, use a large terminal window.

0 commit comments

Comments
 (0)