Cleanup and improved conventions.

This commit is contained in:
Marc
2023-01-13 20:04:00 +01:00
parent 1017d47312
commit 327486d897
3 changed files with 9 additions and 4 deletions
+2 -2
View File
@@ -9,8 +9,8 @@ if(CMAKE_BUILD_TYPE MATCHES DEBUG)
endif()
set(CMAKE_C_FLAGS "-Wall -Wextra -pedantic -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wmaybe-uninitialized")
set(CMAKE_C_FLAGS_DEBUG "-g -fsanitize=address -Werror -O0")
set(CMAKE_C_FLAGS_RELEASE "-g")
set(CMAKE_C_FLAGS_DEBUG "-g -Werror -O0")
set(CMAKE_C_FLAGS_RELEASE "")
# generate the compile_commands for vscode / clang
set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE INTERNAL "")
+4
View File
@@ -0,0 +1,4 @@
* Add tests
* Add safe interrupt support
* Add a gui in an external binary
* make the CLI into a separate binary
+3 -2
View File
@@ -2,17 +2,18 @@
## Function names
### shared functions
### header functions
function should start by the name of their module in camelCase followed by an underscore and the name of the function in camelCase
example:
steam_searchGames()
if the function has the same name as the module then it doesn't need to be repeated.
### static functions
there is no rule for now
all static functions should be in camelCase and they should not mention their module.
## Struct names