Skip to content

Commit d06db07

Browse files
authored
Update README.md
1 parent d74ff17 commit d06db07

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Be sure you have both installed on your system to use bonnet.
1212

1313
## Usage
1414

15-
By default, `bonnet` launches `https://google.com` on a `1024x768` window.
15+
By default, `bonnet` displays the help on a `1024x768` window.
1616

17-
To display the available commands, type `bonnet --help`:
17+
Available options:
1818

1919
```
2020
Launch your front-end and back-end with a single command
@@ -26,7 +26,7 @@ Usage:
2626
--height arg Window height (default: 768)
2727
--title arg Window title (default: bonnet)
2828
--icon arg Window icon path (default: "")
29-
--fullscreen Fullscreen borderless mode
29+
--kiosk-mode Fullscreen borderless mode
3030
--url arg Navigation url (default: https://google.com)
3131
--backend arg Backend process (default: "")
3232
--backend-workdir arg Backend process working dir (default: "")
@@ -47,14 +47,14 @@ Some examples:
4747
bonnet --width 500 --height 500 --title "Italian C++ Community" --icon c:\icons\myicon.ico
4848
```
4949

50-
### Webpage fullscreen
50+
### Webpage kiosk-mode
51+
52+
To lock down user experience on fullscreen and bordeless window, use `--kiosk-mode`:
5153

5254
```
53-
bonnet --fullscreen --url https://italiancpp.org
55+
bonnet --kiosk-mode --url https://italiancpp.org
5456
```
5557

56-
To close the window here, possibly your website does not hinder `ALT+F4`.
57-
5858
### Enable developer tools
5959

6060
Use `--debug` to enable developer tools:
@@ -67,19 +67,23 @@ bonnet --fullscreen --url https://italiancpp.org --debug
6767

6868
### Custom backend process
6969

70+
`bonnet` can optionally launch and hold a process in background. This feature is useful when you need to pair the front-end window with a backend process.
71+
72+
Here is an example:
73+
7074
```
7175
bonnet --fullscreen --url https://your-frontend --backend your-exe.exe
7276
```
7377

74-
Arguments can be added with `--backend-args=arg1,arg2,...`:
78+
Backend arguments might be added with `--backend-args=arg1,arg2,...`:
7579

7680
```
7781
bonnet --fullscreen --url https://italiancpp.org --backend your-exe.exe --backend-args=arg1,arg2
7882
```
7983

80-
By default, bonnet logs the backend's standard output into `bonnet.txt`. To disable only such logging, use `backend-no-log`.
84+
By default, bonnet redirects backend's standard output into the log file `bonnet.txt`. To disable such a redirection, launch the program with `backend-no-log`.
8185

82-
Also, you can show the backend process into its own console (in this case, standard output won't be logged to file):
86+
Sometimes, you might want to show the backend process into its own console (and in this case, standard output won't be logged to file). Then, use `--backend-console`:
8387

8488
```
8589
bonnet --fullscreen --url https://italiancpp.org --backend your-exe.exe --backend-args=arg1,arg2 --backend-console
@@ -91,10 +95,12 @@ Last but not least, when `bonnet`'s window is closed, the backend process will r
9195

9296
## Development
9397

94-
`bonnet` is written in C++20 with the support of:
98+
The idea of `bonnet` comes from [gimmi](https://github.com/gimmi/). I am merely the programmer who has implemented it in C++20 with the support of:
9599
- [cxxopts](https://github.com/jarro2783/cxxopts)
96100
- [webview](https://github.com/webview/webview)
97101
- [tiny-process](https://gitlab.com/eidheim/tiny-process-library)
98102
- WebView2 [nuget package](https://www.nuget.org/packages/Microsoft.Web.WebView2)
99103

100104
For simplicity, the latter only is installed as a Nuget package into the project, the others are stored in `deps/`.
105+
106+
The name *bonnet* is an idea of mine who sometimes wants to name things after famous pirates. As [Stede Bonnet](https://en.wikipedia.org/wiki/Stede_Bonnet) tried with might and main turning to piracy despite his lack of sailing experience, here I am developing a WebView2 program without any previous experience with that technology!

0 commit comments

Comments
 (0)