Skip to content

Commit 1f19f3d

Browse files
committed
updated readme and added devcontainer submodule
1 parent b9d3846 commit 1f19f3d

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

.devcontainer

Submodule .devcontainer added at cfd16ad

.gitmodules

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule ".devcontainer"]
2+
path = .devcontainer
3+
url = [email protected]:CodeIntelligenceTesting/.devcontainer.git
4+
branch = adjust-for-submodules

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ These examples require libssl-dev and libzstd-dev installed on Ubuntu. To instal
99
```sh
1010
sudo apt install libssl-dev libzstd-dev -y
1111
```
12-
If you do not want to install both packages, you can also comment out the include of the simple_examples folder in the main [CMakeLists.txt](CMakeLists.txt#L23) file.
12+
If you do not want to install both packages, you can use a devcontainer to run the examples, or comment out the include of the simple_examples folder in the main [CMakeLists.txt](CMakeLists.txt#L23) file.
1313

1414
In this example, we demonstrate how you can use CI Fuzz to integrate fuzz testing into your C/C++ projects. The example project uses [CMake](https://cmake.org/) as the build system and contains the following examples:
1515
* [Simple Checks Example](src/simple_examples/explore_me.cpp#L10):
@@ -60,4 +60,4 @@ or:
6060
cifuzz coverage
6161
```
6262

63-
To use the devcontainer environment you need to export your cifuzz download token to a environment var called "CIFUZZ_CREDENTIALS" like `export CIFUZZ_CREDENTIALS=[my_token]`.
63+
To make use of the devcontainer setup please run ```git submodule update --init --recursive``` and have a look at the [submodule readme](.decvonatiner/README.md#L1). The second README will only be available after running the command above.

0 commit comments

Comments
 (0)