libamtrack / library

Core library code
GNU General Public License v3.0
7 stars 8 forks source link

Update documentation for building with CMake #122

Open grzanka opened 3 years ago

diamant3 commented 1 year ago

Hello, Can i take this issue?

grzanka commented 1 year ago

Sure

diamant3 commented 1 year ago

Thanks for the reply! Is this the file i need to update? https://github.com/libamtrack/library/blob/master/README_DEVELOPERS

grzanka commented 1 year ago

I'd completely abandon the old README and add contents here: https://github.com/libamtrack/library/blob/master/README.md

I'd also be in favor of using CMake itself not only to generate build files, but also to do build itself, like:

cmake -S . -B build
cmake --build build
cmake --install build
diamant3 commented 1 year ago

Thanks! Got it, but what part of subsection, there's v. subsection and vi. subsection, what do you prefer? or can i merge that into one section then put that building guide?

grzanka commented 1 year ago

I think merging the subsection is the best strategy.

diamant3 commented 1 year ago

Got it! Thanks