README: Added basic usage instructions
This commit is contained in:
parent
ca7e8e5e44
commit
2380a9775b
1 changed files with 43 additions and 0 deletions
43
README.md
Normal file
43
README.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
# convertablet
|
||||
|
||||
Support for tablet-laptop convertible on wlroots-based compositors.
|
||||
|
||||
This project includes both a daemon for handling screen rotation and docking,
|
||||
and some configuration for other software
|
||||
|
||||
## Installation
|
||||
|
||||
### Daemon
|
||||
|
||||
1. Get the code
|
||||
|
||||
```bash
|
||||
git clone https://git.kemonomimi.gay/yukijoou/convertablet && cd convertablet
|
||||
```
|
||||
|
||||
2. Download and build the wayland extensions
|
||||
|
||||
```bash
|
||||
cd wayland-protos/
|
||||
./download_protocols.sh
|
||||
./codegen.sh
|
||||
cd ../
|
||||
```
|
||||
|
||||
3. Build the daemon
|
||||
|
||||
```bash
|
||||
./build.sh
|
||||
```
|
||||
|
||||
4. Run it to try it out
|
||||
|
||||
```
|
||||
./convertablet
|
||||
```
|
||||
|
||||
5. Copy it to /usr/local/bin & make it run at startup
|
||||
|
||||
### Configurations
|
||||
|
||||
Still a work in progress...
|
Loading…
Reference in a new issue