From 18ba83ab93df5ada6aeea5404a7d5cdc4177d1c9 Mon Sep 17 00:00:00 2001 From: Luca Schlecker Date: Sun, 21 Nov 2021 21:39:08 +0100 Subject: [PATCH] add a disclaimer for users of v0.3 that `#define CROW_MAIN` is required. Signed-off-by: Luca Schlecker --- README.md | 4 ++++ docs/getting_started/your_first_application.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/README.md b/README.md index dea5f61e6..80a3d5c6e 100644 --- a/README.md +++ b/README.md @@ -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" diff --git a/docs/getting_started/your_first_application.md b/docs/getting_started/your_first_application.md index 9403c982a..d24f91e1f 100644 --- a/docs/getting_started/your_first_application.md +++ b/docs/getting_started/your_first_application.md @@ -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