Skip to content

Commit bd2611b

Browse files
committed
Updating Readme - Adding App Build CMDs
1 parent 93ec28a commit bd2611b

File tree

1 file changed

+172
-6
lines changed

1 file changed

+172
-6
lines changed

README.md

Lines changed: 172 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,9 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
8686
> **Note**
8787
> We are currently writing documentation.
8888
89-
- [Online Documentation - C](https://webui.me/docs/#/c_api)
90-
- [Online Documentation - C++](https://webui.me/docs/#/cpp_api)
89+
- [Online Documentation](https://webui.me/docs/)
9190

92-
## Build
91+
## Build WebUI Library
9392

9493
- **Windows**
9594

@@ -152,10 +151,177 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
152151
make WEBUI_USE_TLS=1
153152
```
154153

155-
## Examples
154+
## Minimal WebUI Application
156155

157-
- [C](https://github.com/webui-dev/webui/tree/main/examples/C)
158-
- [C++](https://github.com/webui-dev/webui/tree/main/examples/C++)
156+
- **C**
157+
158+
```c
159+
#include "webui.h"
160+
161+
int main() {
162+
size_t my_window = webui_new_window();
163+
webui_show(my_window, "<html><head><script src=\"webui.js\"></script></head> Hello World ! </html>");
164+
webui_wait();
165+
return 0;
166+
}
167+
```
168+
169+
- **C++**
170+
171+
```cpp
172+
#include "webui.hpp"
173+
#include <iostream>
174+
175+
int main() {
176+
webui::window my_window;
177+
my_window.show("<html><head><script src=\"webui.js\"></script></head> C++ Hello World ! </html>");
178+
webui::wait();
179+
return 0;
180+
}
181+
```
182+
183+
- **More C/C++ Examples**
184+
185+
- [C](https://github.com/webui-dev/webui/tree/main/examples/C)
186+
- [C++](https://github.com/webui-dev/webui/tree/main/examples/C++)
187+
188+
- **Other Languages**
189+
190+
- [Wrappers List](#Wrappers)
191+
192+
## Build WebUI Application
193+
194+
- **Windows**
195+
196+
- GCC - Static WebUI
197+
198+
```powershell
199+
gcc -Os -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lws2_32 -Wall -luser32 -static -lole32 -o my_application.exe
200+
```
201+
202+
- GCC - Dynamic WebUI
203+
204+
```powershell
205+
gcc -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "webui-2.dll" -lws2_32 -Wall -luser32 -lole32 -o my_application.exe
206+
```
207+
208+
- MSVC - Static WebUI
209+
210+
```powershell
211+
cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-static.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe
212+
```
213+
214+
- MSVC - Dynamic WebUI
215+
216+
```powershell
217+
cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe
218+
```
219+
220+
**Windows With SSL/TLS (_Optional_)**
221+
222+
- GCC - Static TLS WebUI
223+
224+
```powershell
225+
gcc -Os -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lws2_32 -Wall -luser32 -static -lole32 -o my_application.exe
226+
```
227+
228+
- GCC - Dynamic TLS WebUI
229+
230+
```powershell
231+
gcc -Wl,-subsystem=windows my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "webui-2-secure.dll" -lws2_32 -Wall -luser32 -lole32 -o my_application.exe
232+
```
233+
234+
- MSVC - Static TLS WebUI
235+
236+
```powershell
237+
cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-secure-static.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe
238+
```
239+
240+
- MSVC - Dynamic TLS WebUI
241+
242+
```powershell
243+
cl my_application.c /I"_PATH_TO_WEBUI_INCLUDE_" /link /LIBPATH:"_PATH_TO_WEBUI_LIB_" /SUBSYSTEM:WINDOWS webui-2-secure.lib user32.lib Advapi32.lib Shell32.lib Ole32.lib /OUT:my_application.exe
244+
```
245+
246+
- **Linux**
247+
248+
- GCC - Static WebUI
249+
250+
```sh
251+
gcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application
252+
```
253+
254+
- GCC - Dynamic WebUI
255+
256+
```sh
257+
gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application
258+
```
259+
260+
- Clang - Static WebUI
261+
262+
```sh
263+
clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application
264+
```
265+
266+
- Clang - Dynamic WebUI
267+
268+
```sh
269+
clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application
270+
```
271+
272+
**Linux With SSL/TLS (_Optional_)**
273+
274+
- GCC - Static TLS WebUI
275+
276+
```sh
277+
gcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application
278+
```
279+
280+
- GCC - Dynamic TLS WebUI
281+
282+
```sh
283+
gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application
284+
```
285+
286+
- Clang - Static TLS WebUI
287+
288+
```sh
289+
clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -ldl -o my_application
290+
```
291+
292+
- Clang - Dynamic TLS WebUI
293+
294+
```sh
295+
clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application
296+
```
297+
298+
- **macOS**
299+
300+
- Clang - Static WebUI
301+
302+
```sh
303+
clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -framework Cocoa -framework WebKit -o my_application
304+
```
305+
306+
- Clang - Dynamic WebUI
307+
308+
```sh
309+
clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.dylib" -lpthread -lm -framework Cocoa -framework WebKit -o my_application
310+
```
311+
312+
**macOS With SSL/TLS (_Optional_)**
313+
314+
- Clang - Static TLS WebUI
315+
316+
```sh
317+
clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-secure-static -lpthread -lm -framework Cocoa -framework WebKit -o my_application
318+
```
319+
320+
- Clang - Dynamic TLS WebUI
321+
322+
```sh
323+
clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.dylib" -lpthread -lm -framework Cocoa -framework WebKit -o my_application
324+
```
159325

160326
## Wrappers
161327

0 commit comments

Comments
 (0)