JJSierraM/squiggle.c
1
0
Fork 0
forked from personal/squiggle.c
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README tweaks

Browse Source
This commit is contained in:
NunoSempere 2023-12-09 19:04:42 +00:00
parent bb91fd4473
commit c480565051
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -286,10 +286,10 @@ In fact, squiggle.c does have a few functions for algebraic manipulations of sim
By default, I've enabled -Wall -Wextra -Wdouble-promotion -Wconversion. However, these produce some false positive warnings, which I've dealt with through: By default, I've enabled -Wall -Wextra -Wdouble-promotion -Wconversion. However, these produce some false positive warnings, which I've dealt with through:
- For conversion: Explit casts, particularly from int to size_t when calling malloc. - For conversion: Explicit casts, particularly from int to size_t when calling malloc.
- For dealing with unused variables: Using an UNUSED macro. If you don't like that approach, you could add -Wno-unused-parameter to your makefile and remove the macro and its usage. - For dealing with unused variables: Using an UNUSED macro. If you don't like that approach, you could add -Wno-unused-parameter to your makefile and remove the macro and its usage.
Some ressources on compiler flags: [1](https://nullprogram.com/blog/2023/04/29/), [2](https://news.ycombinator.com/item?id=7371806) Some resources on compiler flags: [1](https://nullprogram.com/blog/2023/04/29/), [2](https://news.ycombinator.com/item?id=7371806)
#### Results of running clang-tidy #### Results of running clang-tidy
@ -382,6 +382,7 @@ Overall, I'd describe the error handling capabilities of this library as pretty
### To do ### To do
- [ ] Drive in a few more real-life applications - [ ] Drive in a few more real-life applications
- [ ] Look into using size_t instead of int for sample numbers
### Done ### Done