SimpleCMakeList

This project shows how to create and build a very simple cmake project. The purpose of this project is to help people to organize the development of their C/C++ projects. It also includes the structure to create the documentation of the project. The directory structure of the Project is as follows:

SimpleCMakeList

├── CMakeLists.txt
├── Examples
│   └── main.c
├── headers
│   ├── cube.h
│   └── square.h
├── LICENSE
├── README.md
├── sources1
│   └── cube.c
└── sources2
|   └── square.c
|
|   ├── build
│   
├── cmake
│   ├── FindCheck.cmake
│   ├── FindSphinx.cmake
│   └── FindValgrind.cmake
├── CMakeLists.txt
├── docs
│   ├── _build
│   ├── CMakeLists.txt
│   ├── conf.py.in
│   ├── index.rst
│   ├── make.bat
│   ├── Makefile
│   ├── _static
│   ├── _templates
│   └── test.rst
├── examples
│   ├── main.c
│   ├── multithreading_advance.c
│   ├── multithreading.c
│   ├── pointer_to_functions1.c
│   ├── pointer_to_functions2.c
│   ├── pointer_to_functions3.c
│   ├── random_test.c
│   ├── unix_c.c
│   └── variable_argument_func.c
├── headers
│   ├── cube.h
│   └── square.h
├── LICENSE
├── README.md
├── sources1
│   └── cube.c
└── sources2
    └── square.c

After you compile the project the generated HTML document looks like :

Hint for documentation

Create a directory called docs in project's root directory. Make sure that you have already installed the Sphinx package, then run the command: sphinx-quickstart. Further information can be found here link

Usuage

Requirements

##Instructions

Building

Clone the repository: https://github.com/MrPoudel/SimpleCMakeList.git
cd SimpleCMakeList
mkdir build
cd build && cmake ..
make

How to add tests

To integrate the tests in cmake we need include(CTest). After that we can use add_test() function to generate the tests. add_test( "name of test" "your_executable" option_arg1 optional_arg_2 ...)

Running the test: $ ctest

How to install the library

With cmake the library can be installed in the CMAKE_INSTALL_PREFIX/your_favored_path directory. In most of the cases, installation means copying the libraries and the header file in bin and include directory. Using install(FILES "library_name_with_path" DESTINATION include) and install(TARGETS "library_name_with_path" DESTINATION lib).

So, the installation directories will be: CMAKE_INSTALL_PREFIX/bin and CMAKE_INSTALL_PREFIX/lib

Installing: $ sudo make install

How to create packaging

Packaging the library means that it can be packed into compressed files. Additionally, we can also create the installation executable. When this executable is installed, it takes care of the library installationa as done by the install command. include(CPack) needs to be added in the CMakeLists.txt file.

Packaging: $ cpack or $ make package After that it will create the .deb package which can be installed using sudo dpkg -i package_name.deb

How to add an existing git repository as a submodule in the repository

To demnstrate this, a very useful external library called uncrustify will be added to this repository.

$ git submodule add https://github.com/uncrustify/uncrustify.git extern/uncrustify

Following code will be added to the main CMakeLists.txt to automatically update the added submodule. taken from: https://cliutils.gitlab.io/modern-cmake/chapters/projects/submodule.html

find_package(Git QUIET)
if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git")
# Update submodules as needed
    option(GIT_SUBMODULE "Check submodules during build" ON)
    if(GIT_SUBMODULE)
        message(STATUS "Submodule update")
        execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init --recursive
                        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
                        RESULT_VARIABLE GIT_SUBMOD_RESULT)
        if(NOT GIT_SUBMOD_RESULT EQUAL "0")
            message(FATAL_ERROR "git submodule update --init failed with ${GIT_SUBMOD_RESULT}, please checkout submodules")
        endif()
    endif()
endif()

if(NOT EXISTS "${PROJECT_SOURCE_DIR}/extern/repo/CMakeLists.txt")
    message(FATAL_ERROR "The submodules were not downloaded! GIT_SUBMODULE was turned off or failed. Please update submodules and try again.")
endif()

Then finally, add_subdirectory(extern/uncrustify) Current dirty way of running the uncrustify for one file:

./uncrustify -c ~/Desktop/SimpleCMakeList/extern/uncrustify/forUncrustifySources.cfg  --no-backup ~/Desktop/SimpleCMakeList/examples/unix_c.c

MrPoudel / SimpleCMakeList