Skip to content

Commit 16e294b

Browse files
authored
Update README.md
1 parent 8579183 commit 16e294b

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Exit the DieKnow application and destroy all threads associated with it.
119119

120120
## DieKnow API
121121

122-
DieKnow provides an API that is accessible at [`dieknow.py`](src/dieknow.py), which just calls the C++ functions.
122+
DieKnow provides an Python API that is accessible at [`dieknow.py`](src/dieknow.py), which just calls the C++ functions. The C/C++ API is found in the `src` directory.
123123

124124
**Directory structure**:
125125

@@ -142,11 +142,11 @@ Associated `*.h` files in the `src` directory are the includes for the implement
142142

143143
#### Why is C++ and Python used and not only Python?
144144

145-
Most users' devices, such as Intel Pentium Silver or Core i3, do not have a lot of computing power. In order to maximize the compute that is available, it is important that a utility like this that is intended to run constantly is well-optimized.
145+
Most users' devices, such as Intel Pentium Silver, N-series and Core i3, do not have a lot of computing power and are more focused on lower power draw rather than performance. As DieKnow is intended to be run constantly in the background, it is especially important this has low resource usage so it has no effect on running programs.
146146

147147
#### How can I compile this myself?
148148

149-
See the [compiling guide](COMPILING.md). You will need a C++ 17 compiler.
149+
See the [compiling guide](COMPILING.md). You will need a C++17 or higher compiler. GitHub Actions automatically builds binaries for every push.
150150

151151
> [!WARNING]
152152
> A current bug with DyKnow sometimes may occur where DyKnow executables that are supposed to be deleted are not deleted, and over time while this app is running the DyKnow installation folder will increase in size by approximately 10 KB/s. In this case, just restart your device and wait for DyKnow to start back up before you kill it, and the excess executables will be cleared. This is very rare and has only been reported once.

0 commit comments

Comments
 (0)