Skip to content

Commit

Permalink
add a disclaimer for users of v0.3 that #define CROW_MAIN is required.
Browse files Browse the repository at this point in the history
Signed-off-by: Luca Schlecker <luca.schlecker@hotmail.com>
  • Loading branch information
luca-schlecker committed Nov 21, 2021
1 parent e5c7dac commit 18ba83a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ Available [here](https://crowcpp.org).

## Examples

#### Disclaimer

> If you are using version v0.3, then you have to put `#!cpp #define CROW_MAIN` at the top of one and only one source file.
#### Hello World
```cpp
#include "crow.h"
Expand Down
4 changes: 4 additions & 0 deletions docs/getting_started/your_first_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ This page shows how you can get started with a simple hello world application.
## 1. Include
Starting with an empty `main.cpp` file, first add `#!cpp #include "crow.h"` or `#!cpp #include "crow_all.h"` if you're using the single header file.

!!! note

If you are using version v0.3, then you have to put `#!cpp #define CROW_MAIN` at the top of one and only one source file.

## 2. App declaration
Next Create a `main()` and declare a `#!cpp crow::SimpleApp` inside, your code should look like this
``` cpp
Expand Down

0 comments on commit 18ba83a

Please sign in to comment.