https://github.com/s-martin/sugarpp

Sugarcpp is a small library, which adds syntactic sugar to C++ to make your life easier.
https://github.com/s-martin/sugarpp

cpp

Last synced: 10 months ago
JSON representation

Sugarcpp is a small library, which adds syntactic sugar to C++ to make your life easier.

• Host: GitHub
• URL: https://github.com/s-martin/sugarpp
• Owner: s-martin
• License: mit
• Created: 2019-03-29T12:10:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-02-01T01:04:37.000Z (over 1 year ago)
• Last Synced: 2025-08-28T03:07:42.000Z (11 months ago)
• Topics: cpp
• Language: CMake
• Homepage: https://s-martin.github.io/Sugarpp
• Size: 399 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Sugarcpp

[![CI-Linux](https://github.com/s-martin/Sugarpp/actions/workflows/ci-linux.yml/badge.svg)](https://github.com/s-martin/Sugarpp/actions/workflows/ci-linux.yml) [![CI-Windows](https://github.com/s-martin/Sugarpp/actions/workflows/ci-windows.yml/badge.svg)](https://github.com/s-martin/Sugarpp/actions/workflows/ci-windows.yml) [![CodeQL](https://github.com/s-martin/Sugarpp/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/s-martin/Sugarpp/actions/workflows/codeql-analysis.yml) [![Microsoft C++ Code Analysis](https://github.com/s-martin/Sugarpp/actions/workflows/msvc.yml/badge.svg)](https://github.com/s-martin/Sugarpp/actions/workflows/msvc.yml)

[![Coverage Status](https://coveralls.io/repos/github/s-martin/Sugarpp/badge.svg?branch=master)](https://coveralls.io/github/s-martin/Sugarpp?branch=master)

Sugarcpp is a small library, which adds syntactic sugar to C++ to make your life easier.

## Compliation

CMake is used for compilation. There are two things to build: the library and the unit tests. Here is the

short version of how to build and test everything:

### Windows

Using [vcpkg](https://github.com/microsoft/vcpkg) to install dependencies is recommended.

1. Clone or download the repository

2. Install dependencies: `vcpkg install boost-test boost-log xerces-c`

#### Visual Studio 2019 or later

3. Open path in Visual Studio as CMake project.

#### Previous versions of Visual Studio

3. `md build && cd build`

4. `cmake ../ -DCMAKE_TOOLCHAIN_FILE=/scripts/buildsystems/vcpkg.cmake`

5. Open created Visual Studio solution file in `build` directory

### Linux (Ubuntu)

1. `sudo apt install libboost-test-dev libboost-log-dev libxerces-c-dev`

If you want to use code coverage:

2. `sudo apt install lcov gcovr`

Configure and build:

3. `mkdir build && cd build`

4. `cmake ../`

5. `make`

Run unit tests:

6. `make test`

# TODO HERE

Run unit tests and create coverage:

7. `make GAlib_lcov`

8. `make GAlib_gcov`

### Building shared libraries

To build shared libraries append `-DBUILD_SHARED_LIBS:BOOL=ON` to the above `cmake`command.

See also  in the CMake docs.