Skip to content

Commit 02328ac

Browse files
AlbertShownAlbertShown
committed
Readme (Organizing Commands)
1 parent 61444bf commit 02328ac

File tree

1 file changed

+78
-154
lines changed

1 file changed

+78
-154
lines changed

‎README.md‎

Lines changed: 78 additions & 154 deletions
Original file line numberDiff line numberDiff line change
@@ -90,22 +90,20 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
9090

9191
## Build WebUI Library
9292

93-
- **Windows**
93+
### Windows
9494

95-
```powershell
96-
# GCC
97-
mingw32-make
98-
99-
# MSVC
100-
nmake
101-
```
102-
103-
**Windows SSL/TLS (_Optional_)**
95+
| Compiler | Command |
96+
|----------|---------|
97+
| GCC | `mingw32-make` |
98+
| MSVC | `nmake` |
10499

100+
<details>
101+
<summary><strong>Windows SSL/TLS (Optional)</strong></summary>
102+
105103
Download and install the OpenSSL pre-compiled binaries for Windows:
106104

107-
- MSVC: [x64 OpenSSL v3.3.1](https://slproweb.com/download/Win64OpenSSL-3_3_1.msi) or [_32Bit_](https://slproweb.com/download/Win32OpenSSL-3_3_1.msi). Please check this [Wiki list](https://wiki.openssl.org/index.php/Binaries) for more info.
108-
- MinGW: [Curl for Windows win OpenSSL](https://curl.se/windows/)
105+
- **MSVC**: [x64 OpenSSL v3.3.1](https://slproweb.com/download/Win64OpenSSL-3_3_1.msi) or [_32Bit_](https://slproweb.com/download/Win32OpenSSL-3_3_1.msi). See the [Wiki list](https://wiki.openssl.org/index.php/Binaries) for more info.
106+
- **MinGW**: [Curl for Windows with OpenSSL](https://curl.se/windows/)
109107

110108
```powershell
111109
# GCC
@@ -114,19 +112,18 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
114112
# MSVC
115113
nmake WEBUI_USE_TLS=1 WEBUI_TLS_INCLUDE="C:\Program Files\OpenSSL-xxx\include" WEBUI_TLS_LIB="C:\Program Files\OpenSSL-xxx\lib"
116114
```
115+
</details>
117116

118-
- **Linux**
119-
120-
```sh
121-
# GCC
122-
make
123-
124-
# Clang
125-
make CC=clang
126-
```
117+
### Linux
127118

128-
**Linux SSL/TLS (_Optional_)**
119+
| Compiler | Command |
120+
|----------|---------|
121+
| GCC | `make` |
122+
| Clang | `make CC=clang` |
129123

124+
<details>
125+
<summary><strong>Linux SSL/TLS (Optional)</strong></summary>
126+
130127
```sh
131128
sudo apt update
132129
sudo apt install libssl-dev
@@ -137,19 +134,22 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
137134
# Clang
138135
make WEBUI_USE_TLS=1 CC=clang
139136
```
137+
</details>
140138

141-
- **macOS**
142-
143-
```sh
144-
make
145-
```
139+
### macOS
146140

147-
**macOS SSL/TLS (_Optional_)**
141+
| Compiler | Command |
142+
|----------|---------|
143+
| Default | `make` |
148144

145+
<details>
146+
<summary><strong>macOS SSL/TLS (Optional)</strong></summary>
147+
149148
```sh
150149
brew install openssl
151150
make WEBUI_USE_TLS=1
152151
```
152+
</details>
153153

154154
## Minimal WebUI Application
155155

@@ -191,137 +191,61 @@ Think of WebUI like a WebView controller, but instead of embedding the WebView c
191191

192192
## Build WebUI Application
193193

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-
```
194+
### Windows
253195

254-
- GCC - Dynamic WebUI
196+
| Compiler | Type | Command |
197+
|----------|--------|---------|
198+
| GCC | Static | `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` |
199+
| GCC | Dynamic | `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` |
200+
| MSVC | Static | `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` |
201+
| MSVC | Dynamic | `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` |
255202

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-
```
203+
<details>
204+
<summary><strong>Windows With SSL/TLS (Optional)</strong></summary>
259205

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-
```
206+
| Compiler | Type | Command |
207+
|----------|--------|---------|
208+
| GCC | Static | `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` |
209+
| GCC | Dynamic | `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` |
210+
| MSVC | Static | `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` |
211+
| MSVC | Dynamic | `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` |
212+
</details>
213+
214+
### Linux
215+
216+
| Compiler | Type | Command |
217+
|----------|--------|---------|
218+
| GCC | Static | `gcc -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application` |
219+
| GCC | Dynamic | `gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application` |
220+
| Clang | Static | `clang -Os my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" -lwebui-2-static -lpthread -lm -ldl -o my_application` |
221+
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2.so" -lpthread -lm -ldl -o my_application` |
222+
223+
<details>
224+
<summary><strong>Linux With SSL/TLS (Optional)</strong></summary>
265225

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-
```
226+
| Compiler | Type | Command |
227+
|----------|--------|---------|
228+
| GCC | Static | `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` |
229+
| GCC | Dynamic | `gcc my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application` |
230+
| Clang | Static | `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` |
231+
| Clang | Dynamic | `clang my_application.c -I"_PATH_TO_WEBUI_INCLUDE_" -L"_PATH_TO_WEBUI_LIB_" "./webui-2-secure.so" -lpthread -lm -ldl -o my_application` |
232+
</details>
233+
234+
### macOS
235+
236+
| Compiler | Type | Command |
237+
|----------|--------|---------|
238+
| Clang | Static | `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` |
239+
| Clang | Dynamic | `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` |
240+
241+
<details>
242+
<summary><strong>macOS With SSL/TLS (Optional)</strong></summary>
285243

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-
```
244+
| Compiler | Type | Command |
245+
|----------|--------|---------|
246+
| Clang | Static | `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` |
247+
| Clang | Dynamic | `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` |
248+
</details>
325249

326250
## Wrappers
327251

0 commit comments

Comments
 (0)