Skip to content

Commit 10dd276

Browse files
docs: Update README
1 parent 4192215 commit 10dd276

1 file changed

Lines changed: 10 additions & 15 deletions

File tree

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,13 @@
1-
# C++ template
1+
# C++fig
22

3-
## C++ version
3+
## Configuration library
4+
This is a C++ library that provides a configuration system for applications. It allows you to define configuration options, load them from files, and access them in a type-safe manner.
45

5-
The CMakeLists file is defining C++20, change the following line for another version:
6+
## Development
67

7-
```
8-
set(CMAKE_CXX_STANDARD 20)
9-
```
10-
11-
## Testing
12-
13-
GTest is available for testing.
14-
15-
## Availability
16-
17-
This template is inteded to be used with VSCode on a development container and targeting/packaging to Linux.
18-
The environment contains some extensions that will aid the development.
8+
The project is structured to use devcontainer for development. To get started, follow these steps:
9+
1. Install [Visual Studio Code](https://code.visualstudio.com/) and the [Remote - Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
10+
2. Clone the repository to your local machine.
11+
3. Open the repository in Visual Studio Code.
12+
4. When prompted, reopen the repository in a container. This will set up the development environment with all necessary dependencies.
13+
5. Once the container is running, you can build and run the project using the CMake extension.

0 commit comments

Comments
 (0)