Skip to content

Commit 3f184b6

Browse files
committed
improve docs
1 parent c2d284a commit 3f184b6

4 files changed

Lines changed: 18 additions & 16 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ Ctrl+F | Open search bar (Enter to find next, Esc to close)
5252

5353
## Documentation
5454

55+
- [User Guide](docs/Users.md)
5556
- [Compilation Guide](docs/Compilation.md)
5657
- [Configuration Guide](docs/Configuration.md)
5758
- [Distribution Guide](docs/Distribution.md)

docs/Distribution.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# How to distribute SharpBrowser with your own branding
22

3-
Step 1: Clone the source using our tutorial
3+
#### Step 1: Clone the source using our tutorial
44

5-
Step 2: Go to Solution explorer, then select the browser folder, then model, then BrowserConfig.cs
5+
#### Step 2: Go to Solution explorer, and navigate `Model > BrowserConfig.cs`
66

77
![image](https://user-images.githubusercontent.com/104514709/183605344-97a50c0f-666a-4132-bf30-760525dc253e.png)
88

9-
Step 3: Rename all of the strings and add your own branding
9+
#### Step 3: Edit the configuration strings
10+
1011
![image](https://user-images.githubusercontent.com/104514709/183605417-67f274b2-fe9d-47b7-9d4e-1722387d2fb8.png)
1112

13+
#### Step 4: Compile the application
1214

13-
Step 4: Compile using the start button
15+
Make sure you select `Release` mode and then compile the application using the Build or Start button.
1416

1517
![image](https://user-images.githubusercontent.com/104514709/183605667-47ce966c-3167-4d34-9bd5-7feadf0710e5.png)
18+
19+
#### Step 5: Create a new installer package
20+
To recreate the setup file, install [InnoSetup](https://jrsoftware.org/isinfo.php) and run the InnoSetup script in the `setup` folder.
21+
22+
#### Step 6: Share your installer package.
23+
Share the newly generated installer package with your friends!

docs/Users.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# How to use SharpBrowser
2+
3+
Simply run the executable `SharpBrowserSetup.exe` and it should install.
4+
5+
This only works on Windows.

setup/README.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

0 commit comments

Comments
 (0)