Bläddra i källkod

Minor readme issues (#16)

* Fix typo in README

* Fix markdown issue

can't use markdown inside an html element
Martin Trigaux 11 månader sedan
förälder
incheckning
c25f81d0c5
2 ändrade filer med 4 tillägg och 4 borttagningar
  1. 1 1
      README.md
  2. 3 3
      kanata/README.md

+ 1 - 1
README.md

@@ -56,7 +56,7 @@ only the thumbs are affected:
 but emits a <kbd>Backspace</kbd> when tapped;
 but emits a <kbd>Backspace</kbd> when tapped;
 - the right thumb key brings the <kbd>Symbols</kbd> layer when hold (similar to
 - the right thumb key brings the <kbd>Symbols</kbd> layer when hold (similar to
 an <kbd>AltGr</kbd> key), and emits <kbd>Return</kbd> when tapped;
 an <kbd>AltGr</kbd> key), and emits <kbd>Return</kbd> when tapped;
-- the spacebar brings the <kbd>Navigation</kbd> layer when when hold.
+- the spacebar brings the <kbd>Navigation</kbd> layer when hold.
 
 
 ![alt, navigation and sym layers under the thumbs](img/base_easy.svg)
 ![alt, navigation and sym layers under the thumbs](img/base_easy.svg)
 
 

+ 3 - 3
kanata/README.md

@@ -48,7 +48,7 @@ cargo install kanata
 Linux users may want to run these extra steps:
 Linux users may want to run these extra steps:
 
 
 <details>
 <details>
-<summary> Running kanata without `sudo` </summary>
+<summary> Running kanata without <code>sudo</code> </summary>
 
 
 kanata needs to intercept `uinput` signals, which it cannot do without the
 kanata needs to intercept `uinput` signals, which it cannot do without the
 proper authorisations.
 proper authorisations.
@@ -56,7 +56,7 @@ proper authorisations.
 If you don’t want to run `kanata` with `sudo`, you’ll need to allow `kanata` to
 If you don’t want to run `kanata` with `sudo`, you’ll need to allow `kanata` to
 read from `uinput`. This requires the users to be part of both `input` and
 read from `uinput`. This requires the users to be part of both `input` and
 `uinput` groups.
 `uinput` groups.
-
+Update README.md
 For that, you first need to create a `uinput` group if it is not the case yet:
 For that, you first need to create a `uinput` group if it is not the case yet:
 
 
 ```bash
 ```bash
@@ -83,7 +83,7 @@ KERNEL=="uinput", MODE="0660", GROUP="uinput", OPTIONS+="static_node=uinput"
 <details>
 <details>
 <summary> Making a user-side systemd service for kanata </summary>
 <summary> Making a user-side systemd service for kanata </summary>
 
 
-Note: This only works if `kanata` is able to run without `sudo` (and are using
+Note: This only works if `kanata` is able to run without <pre>sudo</pre> (and are using
 `systemd`).
 `systemd`).
 
 
 Using a `systemd service` allows running `kanata` as a daemon, possibly right
 Using a `systemd service` allows running `kanata` as a daemon, possibly right