mirror of
https://github.com/Lurkki14/tuxclocker.git
synced 2025-02-25 18:55:24 -06:00
add formatting section
This commit is contained in:
parent
8245ba3489
commit
0293e8606f
35
README.md
35
README.md
@ -26,8 +26,33 @@ ninja && sudo ninja install
|
||||
|
||||
```
|
||||
|
||||
# Screenshots
|
||||
|
||||
### Main view
|
||||
|
||||

|
||||
|
||||
### Editing an item
|
||||
|
||||

|
||||
|
||||
# Developing
|
||||
|
||||
### Formatting
|
||||
|
||||
TuxClocker uses `clang-format`. Code should be formatted with the provided `clangFormat.sh` script.
|
||||
|
||||
NOTE: to get designated initializers formatted like so:
|
||||
``` cpp
|
||||
auto Foo = Foo{
|
||||
.bar = 1,
|
||||
.baz = 2,
|
||||
};
|
||||
```
|
||||
a trailing comma should be used after the last member (`clang-format` weirdness).
|
||||
|
||||
### Scripts
|
||||
|
||||
There are a few scripts in `dev/` for development convenience, mainly to deal with DBus. A separate DBus instance and custom config file is used, so the TuxClocker daemon is able to be registered without installing service files into the system.
|
||||
|
||||
Note: the following scripts assume TuxClocker is installed to `inst/`, so `meson` should be called as follows:
|
||||
@ -44,13 +69,3 @@ The scripts should be used in this order (they all have to be running simultaneo
|
||||
`dev/gui-start.sh` Launches the TuxClocker GUI making it connect to our separate DBus instance, so it can find the TuxClocker DBus service.
|
||||
|
||||
You can also use a program like `d-feet` if you are only making changes to the daemon. (To be documented)
|
||||
|
||||
# Screenshots
|
||||
|
||||
### Main view
|
||||
|
||||

|
||||
|
||||
### Editing an item
|
||||
|
||||

|
||||
|
Loading…
Reference in New Issue
Block a user