aselimov/cpp_project_template
Template
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ENH: remove manual clone Google Test instructions

Browse Source 
CMake now preforms the clone operation.
This commit is contained in:
Timothy Helton 2017-12-28 15:27:30 -07:00
parent ab5df877fc
commit 4ed070789f
1 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -24,19 +24,11 @@ Feel free to fork this repository and tailor it to suit you.
- This variable will be used in a couple of different places. - This variable will be used in a couple of different places.
- MyProject_run: will be the main executable name - MyProject_run: will be the main executable name
- MyProject_lib: will be the project library name - MyProject_lib: will be the project library name
1. Line 4: Set the version of C++ to use. For example let's set up the 1. Line 4: Set the version of C++ to use. For example, let's set up the
CoolProject to use C++ 11. CoolProject to use C++ 11.
```cmake ```cmake
set(CMAKE_CXX_STANDARD 11) set(CMAKE_CXX_STANDARD 11)
``` ```
1. Clone Google Test project into the `test/lib` directory.
```bash
git clone git@github.com:google/googletest.git MyProject/tests/lib
```
1. Rename the Google Test main directory to `googletest-master`.
```bash
mv MyProject/tests/lib/googletest MyProject/tests/lib/googletest-master
```
1. Update project name and description in the `Doxyfile` located in the `docs` 1. Update project name and description in the `Doxyfile` located in the `docs`
directory. directory.
1. Update line `PROJECT_NAME` 1. Update line `PROJECT_NAME`
@ -50,34 +42,34 @@ directory.
## CLION IDE Specific Instructions ## CLION IDE Specific Instructions
I started using an IDE from [JET Brains](https://www.jetbrains.com/) tailored I started using an IDE from [JET Brains](https://www.jetbrains.com/) tailored
for Python called [PyCharm](https://www.jetbrains.com/pycharm/), and thought for Python called [PyCharm](https://www.jetbrains.com/pycharm/) and thought
it helped me write better code. it helped me write better code.
I'd been wanting to learn C++ and decided to give JET Brains C/C++ IDE called I'd been wanting to learn C++ and decided to give JET Brains C/C++ IDE called
[CLion](https://www.jetbrains.com/clion/) a try. [CLion](https://www.jetbrains.com/clion/) a try.
The code completion, interactive suggestions, debugger, introspection tools, The code completion, interactive suggestions, debugger, introspection tools,
and built in test execution are very handy. and built-in test execution are very handy.
There are a couple extra details to set when using this IDE. There are a couple extra details to set when using this IDE.
1. The IDE allows you to mark directories with their desired purpose. 1. The IDE allows you to mark directories with their desired purpose.
To mark a directory right click on the directory name in the `Project` window To mark a directory right click on the directory name in the `Project` window
and select `Mark Directory as` from the drop down menu. and select `Mark Directory as` from the drop-down menu.
1. Mark the `src` directory as `Project Sources and Headers` 1. Mark the `src` directory as `Project Sources and Headers`
1. Mark the `tests/lib/googletest-master` directory as `Library Files` 1. Mark the `tests/lib/googletest` directory as `Library Files`
1. Setup the `Run/Debug Configuration` by selecting `Edit Configurations...` 1. Setup the `Run/Debug Configuration` by selecting `Edit Configurations...`
from the pull down menu from the run button (green triangle) in the upper right from the pull-down menu from the run button (green triangle) in the upper right
corner. corner.
1. Update Doxygen Build to execute the unit test suite. 1. Update Doxygen Build to execute the unit test suite.
1. Select Doxygen from the Application menu on the left. 1. Select Doxygen from the Application menu on the left.
1. Choose the **executable** for Doxygen to be `Unit_Tests_run`. 1. Choose the **executable** for Doxygen to be `Unit_Tests_run`.
1. Create a `Google Test` configuration 1. Create a `Google Test` configuration
1. In the upper left corner select the plus symbol. 1. In the upper left corner select the plus symbol.
1. Chose `Google Test` from the drop down menu. 1. Chose `Google Test` from the drop-down menu.
1. Set **Name** to `Unit Tests`. 1. Set **Name** to `Unit Tests`.
1. Set **Target** to `Unit_Tests_run`. 1. Set **Target** to `Unit_Tests_run`.
## Wrap Up ## Wrap Up
That should be all it takes to start writing code. That should be all it takes to start writing code.
If you find any issues or bugs with this repository please file an issue on If you find any issues or bugs with this repository please file an issue on
GitHub. [GitHub](https://github.com/TimothyHelton/cpp_project_template/issues).
Hope you find this template useful and enjoy learning C++! Hope you find this template useful and enjoy learning C++!