Skip to content

Commit

Permalink
docs: update docs for features and contrib guides
Browse files Browse the repository at this point in the history
  • Loading branch information
lavafroth committed Oct 17, 2024
1 parent c1f516d commit 797d88b
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,29 +30,22 @@ As of now, the parser prints all the bindings that a given inputs file can expan
- [x] Imports
- [x] Merge definitions from all imports
- [x] Tests
- [ ] Integration into downstream [WIP](https://github.com/lavafroth/swhkd/tree/sweet-integration)
- [x] Integration into [downstream](https://github.com/waycrate/swhkd)

## Extra features
- [x] Warn user if input config is not a regular file
- [x] Set a maximum file size cap for configs
- [x] Set a maximum file size cap for configs (limit configurable in the `build.rs`)
- [x] Map keys and modifiers to internal representation (evdev enum variants) in a single pass


Want to learn how the code works? Check out [my blog](https://lavafroth.is-a.dev/tags/google-summer-of-code/) where I cover each topic as I implement them.

### See it in action

All the examples that are currently tested against are piled up in the
`hotkeys.swhkd` file. These are to be ported to actual cargo tests.

To see a structured representation of the sample config file after parsing, run the following:

```
cargo r -- hotkeys.swhkd
```

To run all available tests, run `cargo test`

### Contributing

This repo is for cathedral style development. I'm assigned with creating the parser and there's potential financial transactions involved. Contributions are NOT welcome.

0 comments on commit 797d88b

Please sign in to comment.