Skip to content
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

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Update README.md #329

merged 1 commit into from
Oct 10, 2023

Conversation

kamari-a
Copy link
Contributor

I've made some proposed updates to the following sections:

  • introduction
  • installation
  • packaging
  • contributing sections

updates to intro, installation, packaging, and contributing sections
@github-actions github-actions bot added the repo something about repo label Jul 12, 2023
@ghost
Copy link

ghost commented Jul 12, 2023

👇 Click on the image for a new way to code review

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map legend

Copy link
Collaborator

@nrkramer nrkramer left a 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch, thanks!

Comment on lines -205 to +202
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!
Copy link
Collaborator

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 ?

Copy link
Owner

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!

@nrkramer
Copy link
Collaborator

nrkramer commented Oct 9, 2023

@ZigRazor This looks largely complete. Maybe we should just merge it as there's been no progress for awhile

@ZigRazor ZigRazor marked this pull request as ready for review October 10, 2023 09:51
@ZigRazor ZigRazor merged commit 92fca0a into ZigRazor:master Oct 10, 2023
4 checks passed
@badumbatish
Copy link
Contributor

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

@nrkramer
Copy link
Collaborator

The doc needs updating. Your workflow is correct.

@badumbatish
Copy link
Contributor

The doc needs updating. Your workflow is correct.

Should I create a branch and do a pull request?

@nrkramer
Copy link
Collaborator

Please do! Thank you! 😀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo something about repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants