Update the README.
This commit is contained in:
22
README.md
22
README.md
@@ -9,29 +9,19 @@ file with the output so that it is much more readable.
|
|||||||
To run the program, simply run it as follows:
|
To run the program, simply run it as follows:
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ qdbus-prettifier <in-file> <out-file>
|
qdbus-prettifier <in-file> <out-file>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
Requirements:
|
To compile the program, install the Rust suite, namely the compiler and Cargo.
|
||||||
|
Once installed you can run `cargo build --release` to generate a release build
|
||||||
|
of the project which will be found at `target/release/dbus-prettifier`.
|
||||||
|
|
||||||
- C compiler that supports GNU99 (GCC recommended).
|
To install you can use the `install` command as follows:
|
||||||
- (GNU) Make
|
|
||||||
|
|
||||||
Build with `make`:
|
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ make
|
install -Dm755 target/release/dbus-prettifier /usr/local/bin
|
||||||
cc -std=gnu99 -Wall -Wextra -Wfatal-errors -Werror -O2 -DNDEBUG -c -o src/main.o src/main.c
|
|
||||||
cc -o dbus-prettifier src/main.o
|
|
||||||
```
|
|
||||||
|
|
||||||
Install with `make install`:
|
|
||||||
|
|
||||||
```console
|
|
||||||
$ sudo make install
|
|
||||||
install -Dm755 dbus-prettifier /usr/local/bin/
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
Reference in New Issue
Block a user