You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,3 +2,23 @@
2
2
3
3
Control various aspects of Microsoft Surface devices on Linux from the Command-Line.
4
4
Aims to provide a unified front-end to the various sysfs-attributes and special devices.
5
+
6
+
## Building from Source
7
+
8
+
Building this application from source follows the standard rust procedure, i.e. simply call `cargo build --release --locked` for a release-ready executable.
9
+
Completion files are automatically generated and can be found in the corresponding `target/release/build/surface-<hash>/out/` directory.
10
+
11
+
### Arch Linux
12
+
13
+
You can generate a package using the provided PKGBUILD in the `pkg/arch` directory.
14
+
15
+
### Debian
16
+
17
+
Generating a Debian package can be done via [`cargo deb`](https://github.com/mmstick/cargo-deb).
18
+
Specifically, you need to run
19
+
```
20
+
env CARGO_TARGET_DIR=target CARGO_INCREMENTAL=0 cargo deb
21
+
```
22
+
where setting `CARGO_TARGET_DIR` is required to output the generated auto-completion files at the correct location for cargo-deb to pick up.
23
+
24
+
The final package can be found in `target/debian`.
0 commit comments