Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Align docs and dependencies #18

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from
Draft

Conversation

lefticus
Copy link
Member

@lefticus lefticus commented Apr 1, 2022

  • upgrade project_options
  • consider forking project_options
  • update cmake version required
  • check documents for required compilers/C++ verison

@lefticus lefticus changed the base branch from develop to main April 1, 2022 03:56
@lefticus lefticus changed the base branch from main to develop April 1, 2022 03:56
@lefticus
Copy link
Member Author

lefticus commented Apr 1, 2022

Note @ddalcino this is based onto develop so it can easily be fully vetted before merging.

@codecov-commenter
Copy link

codecov-commenter commented Apr 1, 2022

Codecov Report

Merging #18 (c0f0f5b) into develop (f37c1ab) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop      #18   +/-   ##
========================================
  Coverage    77.77%   77.77%           
========================================
  Files            3        3           
  Lines           36       36           
  Branches        19       19           
========================================
  Hits            28       28           
  Misses           7        7           
  Partials         1        1           
Flag Coverage Δ
Linux 37.03% <ø> (ø)
Windows 80.00% <ø> (ø)
macOS 38.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f37c1ab...c0f0f5b. Read the comment docs.

@ddalcino
Copy link
Contributor

ddalcino commented Apr 1, 2022

According to https://en.cppreference.com/w/cpp/compiler_support, there are still C++20 features that are as yet unsupported by clang. GCC 11 and the current release of Visual Studio 2019 both have full support for C++20.

It's possible that earlier versions of clang, GCC, and MSVC can successfully compile cpp_boilerplate_project. However, I think it's disingenuous to tell our users that an older version will work when they start using C++20 features that aren't demonstrated in the project.

It is my contention that we are already testing the oldest compilers that are compatible with the project; we just need to update the README to reflect the new versions.

ddalcino added 3 commits April 2, 2022 14:49
Many of the optional dependencies will trigger warnings on build if
they are not installed.
If they are not strongly encouraged to install these, it is likely
that many users will simply ignore them and trigger the warnings.
README_dependencies.md Outdated Show resolved Hide resolved
The GUI libraries are in cpp_starter_project, not cpp_boilerplate_project,
so they do not need to be discussed here.
Comment on lines 41 to 48
- Debian/Ubuntu:
- Ubuntu 21.04+:

sudo apt install gcc-11

- Ubuntu 18.04-20.04:

sudo apt install build-essential
sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test && sudo apt-get update -qq
sudo apt install gcc-11
Copy link
Contributor

Choose a reason for hiding this comment

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

This probably deserves comment. I am removing instructions on how to install gcc-11 on Debian.

I've looked into installing gcc-11 on Debian briefly, and it looks complicated enough that I would have to manually test the instructions I've found. I'm not going to do that, because Debian not widely used. I think it would make more sense to add instructions for Arch-derived distros and Fedora.

@ddalcino
Copy link
Contributor

ddalcino commented Apr 7, 2022

Is there anything left to do here?

Do we really need to fork project_options? Honestly, I don't see a pressing need to do so at the moment. I am tempted to just watch and wait until something breaks.

@ddalcino
Copy link
Contributor

Whoa, that merge really didn’t work out. I’m not clear on what happened to Visual Studio, and I really wasn’t expecting the template janitor to fire. Any ideas here?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants