Skip to content

Commit

Permalink
Add core
Browse files Browse the repository at this point in the history
  • Loading branch information
tekezo committed Jul 7, 2023
1 parent fcc1450 commit 88d8ad4
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "core"]
path = core
url = https://github.com/pqrs-org/KE-complex_modifications-core.git
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ all:
@echo "============================================================"
@echo

bash scripts/update-json.sh
sandbox-exec -f core/files/generator.sb bash scripts/update-json.sh
python3 scripts/lint-src-json.py src/json
python3 scripts/lint-public-json.py public/json
ruby scripts/lint-groups.rb
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,17 @@ complex_modifications for Karabiner-Elements.

## Add rules

1. Put a JSON generator file (`.rb`, `.erb` or `.js`) into [src/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/src/json).
1. Clone repository.

```shell
git clone --depth 1 https://github.com/pqrs-org/KE-complex_modifications.git
cd KE-complex_modifications
git submodule update --init --recursive --depth 1
```

2. Put a JSON generator file (`.rb`, `.erb` or `.js`) into [src/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/src/json).
(Or put a `.json` file directly into [public/json](https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/json) directly.)
2. <details>
3. <details>
<summary>(Optional) Update <a href="https://github.com/pqrs-org/KE-complex_modifications/tree/main/public/groups.json">public/groups.json</a> if you want to add your rules into specific category.</summary>

Add the following entry into `groups.json`.
Expand All @@ -25,7 +33,7 @@ complex_modifications for Karabiner-Elements.

</details>

3. Run `make` command on Terminal. <br/> If you've a generator file into `src/json`, formatted json file will be auto generated in the `public/json/your_awesome_configuration.json`.
4. Run `make` command on Terminal. <br/> If you've a generator file into `src/json`, formatted json file will be auto generated in the `public/json/your_awesome_configuration.json`.
```shell
make
Expand Down
1 change: 1 addition & 0 deletions core
Submodule core added at 6165ec

0 comments on commit 88d8ad4

Please sign in to comment.