Skip to content

Commit

Permalink
Updated README.md for v0.1.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
wardru committed Oct 31, 2023
1 parent 76bd1eb commit f47f534
Showing 1 changed file with 18 additions and 37 deletions.
55 changes: 18 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ User library to develop C++ applications following Panduza API.

### Build Deps

| Package | Version |
| ------- | ------- |
| conan | 1.58 |
| cmake | 3.25.0 |
| Package | Version |
| ------- | -------- |
| conan | 1.60 |
| cmake | >=3.25.0 |

Library dependencies are managed wih Conan.

Expand All @@ -25,45 +25,26 @@ To install conan, https://conan.io/downloads.html.
| Google test | cci.20210126 | |
| cppcheck | 2.10 | |

## Version

The version of the library is fetched from the top line of CHANGELOG.md.

## Build

To build the library in Debug or Release mode:

```
mkdir build
cd build
conan install .. --build=missing -s build_type=<build mode>
cmake -DCMAKE_INSTALL_PREFIX=./install -DCMAKE_BUILD_TYPE=<build mode> -DCMAKE_TOOLCHAIN_FILE=./<build mode>/generators/conan_toolchain.cmake ..
cmake --build .
cmake --install .
./scripts/install_dependencies.sh
./scripts/build.sh
```

To build and export the library as a conan package:

```
mkdir build
cd build
conan create .. --build=missing -s build_type=<build mode>
$ ./scripts/install_dependencies.sh --help
Usage: ./scripts/install_dependencies.sh [-t <target>] [-l <lib>] [-b <build>] [-h]
-t --target Target platform (Windows or Linux). Default is Linux
-l --lib Library mode (Static or Shared). Default is Shared
-b --build Build mode (Debug or Release). Default is Debug
-h --help Display this help message
```

## Test

After building the library, you can test it with:

```
cd build
make test
```

## Check

You can use cppcheck to examine the code.

$ ./scripts/build.sh --help
Usage: ./scripts/build.sh [-t <target>] [-l <lib>] [-b <build>] [-h]
-t --target Target platform (Windows or Linux). Default is Linux
-l --lib Library mode (Static or Shared). Default is Shared
-b --build Build mode (Debug or Release). Default is Debug
-h --help Display this help message
```
cd build
make check
```

0 comments on commit f47f534

Please sign in to comment.