-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md #329
Update README.md #329
Conversation
updates to intro, installation, packaging, and contributing sections
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good so far! Only one nit from me.
- A GCC compiler version greater than 7.3.0 *OR* | ||
- A MSVC compiler that supports C++17 | ||
- The minimum C++ standard required is **C++17** | ||
- A GCC compiler version 7.3.0 and later *OR* a MSVC compiler that supports C++17 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great catch, thanks!
The use of the library is very simple, **just put the header file where you need!** | ||
To use the library **simply put the header file where you need it.** It's that easy! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think this is strictly true yet. I think there were plans to add a script to merge all the code into a single header. Do we have an issue to track this @ZigRazor ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not yet, but it can be open!
@ZigRazor This looks largely complete. Maybe we should just merge it as there's been no progress for awhile |
Hi there, I noticed that when I was working on #298 and noticed that for testing, I need to run mkdir -p build # Create a directory to hold the build output
cd build # Enter the build folder
cmake -DTEST=ON .. # Generate native build scripts for GoogleTest
make # Compile instead of mkdir -p build # Create a directory to hold the build output
cd build # Enter the build folder
cmake .. # Generate native build scripts for GoogleTest
make # Compile Is my workflow wrong or is the doc needs updating |
The doc needs updating. Your workflow is correct. |
Should I create a branch and do a pull request? |
Please do! Thank you! 😀 |
I've made some proposed updates to the following sections: