Skip to content

Commit 1b43a2f

Browse files
Update README.md
1 parent 5c22661 commit 1b43a2f

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,25 @@ If you'd to support Librum's development, check out: https://librumreader.com/co
6161
<br>
6262
All of the current feature requests, bugs and tasks are listed in the [issues](https://github.com/Librum-Reader/Librum/issues). Easy tasks are labeled "good first issue", so that is a good starting point.
6363
<br>
64+
<br>
65+
To ensure a consistent style across the codebase, we enforce auto-formatting using clang-format for c++ and the QML formatter for qml code. Make sure to setup both as described here before you contribute.
66+
67+
<b>Qml Formatter:</b>
68+
- Go to Edit->Preferences
69+
- Tick the "Enable auto format on file save" checkbox under "Qt Quick"->"QML/Js Editing"
70+
![pic](https://github.com/user-attachments/assets/93138f09-c221-42e6-a8d2-06babfabc562)
71+
72+
<b>Clang Format:</b>
73+
- Install on windows (https://releases.llvm.org/download.html) or linux
74+
- Get the Beautifier Plugin on Qt Creator
75+
- Go to Edit->Preferences and select Beautifier
76+
- Select the following in the general Tab
77+
![Screenshot 2025-06-19 231737](https://github.com/user-attachments/assets/c9ad066e-5fbb-4bd4-8cb0-2b2ea71ee14c)
78+
- At last, set these settings
79+
![image](https://github.com/user-attachments/assets/91995519-25b7-45bd-9c3e-55d569a979cd)
80+
81+
82+
6483
<br>
6584
PS: Feel free to tag me (@DavidLazarescu) in the comments of any issue if you have questions.
6685

0 commit comments

Comments
 (0)