Merge pull request #2 from Rewrk-ltd/master

Better documentation
PTFOPlayer · Mar 20, 2023 · 7f484b5 · 7f484b5
2 parents 56ea44f + b85dd8e
commit 7f484b5
Showing 1 changed file with 43 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,51 +1,46 @@
-# screenpad_rs
+# Screenpad_rs
 Simple CLI wrapper to change brightness of asus screenpad
 
 
-# instalation
-  ### pre-compiled binaries
-    * if you want, you can use precompiled binaries in screenpad_rs_binaries.tar.gz
+# Install
+### Pre-compiled binaries
+Precompiled binaries are in screenpad_rs_binaries.tar.gz
 
-  ### dependencies:
-    * rustup
-    * wget
-    * dkms
-    * linux-headers
-  ### automatic install
-    * install [Plippo asus-wmi-screenpad repo](https://github.com/Plippo/asus-wmi-screenpad)
-    * clone repository
-    ```
-    git clone https://github.com/PTFOPlayer/screenpad_rs && cd screenpad_rs
-    ```
-    * run
-    ```
-    ./install.sh
-    ```
-  ### steps:
-    * install [Plippo asus-wmi-screenpad repo](https://github.com/Plippo/asus-wmi-screenpad)
-    * clone repository
-    ```
-    git clone https://github.com/PTFOPlayer/screenpad_rs && cd screenpad_rs
-    ```
-    * now you can run build
-    ```
-    cargo build --release
-    ```
-    * lastly just coppy needed files and create place for config
-    ```
-    sudo cp target/release/screenpad_rs /usr/bin
-    sudo cp ./src/brightness.sh /usr/bin/brightness.sh
-    sudo cp ./src/current.sh /usr/bin/current.sh
-    sudo mkdir /usr/share/screenpad_rs
-    sudo echo 100 > /usr/share/screenpad_rs/brightness
-    ```
-  ### automatic synchronization
-    * if you want to use synchronization service you need to do:
-    ```
-    sudo systemctl start screenpad_rs.service
-    sudo systemctl enable screenpad_rs.service
-    ```
-# usage
+### Dependencies:
+* rustup
+* wget
+* dkms
+* linux-headers
+
+Install [Plippo asus-wmi-screenpad repo](https://github.com/Plippo/asus-wmi-screenpad), clone repository
+```
+git clone https://github.com/PTFOPlayer/screenpad_rs && cd screenpad_rs
+```
+### Automatic install
+```
+./install.sh
+```
+### Steps
+
+1. Run build
+```
+cargo build --release
+```
+2. Copy needed files and create place for config
+```
+sudo cp target/release/screenpad_rs /usr/bin
+sudo cp ./src/brightness.sh /usr/bin/brightness.sh
+sudo cp ./src/current.sh /usr/bin/current.sh
+sudo mkdir /usr/share/screenpad_rs
+sudo echo 100 > /usr/share/screenpad_rs/brightness
+```
+### Automatic synchronization
+To use synchronization service:
+```
+sudo systemctl start screenpad_rs.service
+sudo systemctl enable screenpad_rs.service
+```
+# Usage
 | flag | simplified | what is doing | 
 | ---| --- | --- |
 | --brightness | -b |   : changes brightness in values from 1 to 255, |
@@ -57,12 +52,7 @@ Simple CLI wrapper to change brightness of asus screenpad
 | --down | -d |   : decreases brightness by 10 |
 | --watch | -w |   : automatic sync |
 
-# TODO
-  * touch mapping on/off
-  * brightness profiles
-  * GUI 
-
-# DONE
-  * install.sh
-  * brightenss info 
-  * synchronization service
+### TODO
+* Touch mapping on/off
+* Brightness profiles
+* GUI