search

huynguyen-and-friend-projects / smoldb

Simple database in C(++)
1 stars 3 forks source link

Update documentation, and CMakeLists #19

Closed nguyenhuy0905 closed 4 months ago

nguyenhuy0905 commented 4 months ago

Update documentation, and CMakeLists

Fix the Ming-gw64 command-line package download instructions to explicitly use ucrt packages. Add general guide on how to debug, format, and lint your code. Add general guide on how to lint the Markdown docs. I also made the -fsanitize=leak flag optional, and off by default.

I realized the "generic" package on Ming-gw64 will download to all the places. So, specifying it's UCRT64 makes everything sit inside the UCRT64 directory. Sanitization is a performance hit, so I let it be optional.

I updated the command to run inside UCRT64, and added a new section called "How-to" for general guide. If you have any more questions, please create an Issue. Whatever question it is, will be updated on the "how-to."

With this out of the way, we are (almost) ready for doing some actual code.

@qu-ngx @AbstractionHLR @BAOELIETRAN @bebeminhminh

Pull request by: Huy Nguyen

nguyenhuy0905 commented 4 months ago

You know, CMake isn't too shabby once you know a good amount of flags that can be passed to Clang or GCC :smile: