diff --git a/README.md b/README.md index 09384f9d..a860cb0b 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It includes * a basic CLI example * examples for fuzz, unit, and constexpr testing - * large github action testing matrix + * large GitHub action testing matrix It requires @@ -32,15 +32,16 @@ This project gets you started with a simple example of using FTXUI, which happen ## Getting Started -### Use the Github template +### Use the GitHub template First, click the green `Use this template` button near the top of this page. -This will take you to Github's ['Generate Repository'](https://github.com/cpp-best-practices/cmake_template/generate) page. +This will take you to GitHub's ['Generate Repository'](https://github.com/cpp-best-practices/cmake_template/generate) +page. Fill in a repository name and short description, and click 'Create repository from template'. -This will allow you to create a new repository in your Github account, +This will allow you to create a new repository in your GitHub account, prepopulated with the contents of this project. After creating the project please wait until the cleanup workflow has finished -setting up your project and commited the changes. +setting up your project and committed the changes. Now you can clone the project locally and get to work! diff --git a/README_dependencies.md b/README_dependencies.md index 430cafbc..b0ea2c4c 100644 --- a/README_dependencies.md +++ b/README_dependencies.md @@ -2,7 +2,7 @@ Note about install commands: - for Windows, we use [choco](https://chocolatey.org/install). -- for MacOS, we use [brew](https://brew.sh/). +- for macOS, we use [brew](https://brew.sh/). - In case of an error in cmake, make sure that the dependencies are on the PATH. diff --git a/cmake/Cuda.cmake b/cmake/Cuda.cmake index d784a882..f6265aea 100644 --- a/cmake/Cuda.cmake +++ b/cmake/Cuda.cmake @@ -42,7 +42,7 @@ macro(myproject_target_link_cuda target) if(WIN32 AND "$ENV{VSCMD_VER}" STREQUAL "") message( WARNING - "Compiling Cuda on Windows outside the Visual Studio Commant prompt or without running `vcvarsall.bat x64` probably fails" + "Compiling CUDA on Windows outside the Visual Studio Command prompt or without running `vcvarsall.bat x64` probably fails" ) endif() endmacro() diff --git a/cmake/Utilities.cmake b/cmake/Utilities.cmake index 6fa78b28..e278f518 100644 --- a/cmake/Utilities.cmake +++ b/cmake/Utilities.cmake @@ -1,4 +1,4 @@ -# find a subtring from a string by a given prefix such as VCVARSALL_ENV_START +# find a substring from a string by a given prefix such as VCVARSALL_ENV_START function( find_substring_by_prefix output diff --git a/cmake/VCEnvironment.cmake b/cmake/VCEnvironment.cmake index a95cb467..2ed4d582 100644 --- a/cmake/VCEnvironment.cmake +++ b/cmake/VCEnvironment.cmake @@ -19,7 +19,7 @@ macro(detect_architecture) set(VCVARSALL_ARCH ${CMAKE_HOST_SYSTEM_PROCESSOR}) else() set(VCVARSALL_ARCH x64) - message(STATUS "Unkown architecture CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR_LOWER} - using x64") + message(STATUS "Unknown architecture CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR_LOWER} - using x64") endif() endif() endmacro() diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt index 0739f424..50f8e633 100644 --- a/test/CMakeLists.txt +++ b/test/CMakeLists.txt @@ -10,7 +10,7 @@ if(PROJECT_IS_TOP_LEVEL OR TEST_INSTALLED_VERSION) find_package(myproject CONFIG REQUIRED) # for intro, project_options, ... if(NOT TARGET myproject_options) - message(FATAL_ERROR "Requiered config package not found!") + message(FATAL_ERROR "Required config package not found!") return() # be strictly paranoid for Template Janitor github action! CK endif() endif()