Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some simple documentation #64

Merged
merged 6 commits into from
Aug 11, 2022
Merged

Add some simple documentation #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1655bde
initial docs
LandarXT Aug 9, 2022
4e36ed8
(docs) Add compiling instructions
LandarXT Aug 9, 2022
7e39ab2
(docs) initial distribute
LandarXT Aug 9, 2022
8c9ac3f
(docs) Document BrowserConfig.cs
LandarXT Aug 9, 2022
c2b4efd
(docs) Finish how to distribute
LandarXT Aug 9, 2022
8a67aae
Merge branch 'sharpbrowser:master' into docs
LandarXT Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/BrowserConfigDocs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Options:
### Branding
The title of the window and application in Windows
### AcceptLanguage
The language you distribute it in
### UserAgent
The browser's user agent string, which shows to websites what browser it is
### HomepageURL
The home page of your browser which shows up when you press the home button
### NewTabURL
The page you will see when you press "New Tab"
### InternalURL
The main URL for internal pages
### DownloadsURL
The URL for the downloads page
### FileNotFoundURL
The File not found error internal url
### CannotConnectURL
The cannot correct error url
### SearchURL
The search string; it must be the string before the search result
Examples:

https://www.google.com/search?q=

https://www.bing.com/search?q=

https://duckduckgo.com/?q=
15 changes: 15 additions & 0 deletions docs/HowToDistribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# How to Distribute with your own branding

Step 1: Clone the source using our tutorial

Step 2: Go to Solution explorer, then select the browser folder, then model, then BrowserConfig.cs

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

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


Step 4: Compile using the start button

![image](https://user-images.githubusercontent.com/104514709/183605667-47ce966c-3167-4d34-9bd5-7feadf0710e5.png)
22 changes: 22 additions & 0 deletions docs/compiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# How to compile SharpBrowser

Step 1: Fork the sharpbrowser repository on GitHub
![image](https://user-images.githubusercontent.com/104514709/183603613-65eff2a1-0d80-4e70-83d8-805edecd2c0c.png)

Step 2: Download Visual Studio Community with the "Desktop development with .NET" component


![image](https://user-images.githubusercontent.com/104514709/183603285-8d1a52cf-4cb8-4464-b55e-34d1a17a2c31.png)


Step 2: Open VS Community and select "Clone a repository"

![image](https://user-images.githubusercontent.com/104514709/183603374-2b2d4c84-c58e-474c-a335-fded1838e9ed.png)

Step 3: Type in your sharpbrowser fork URL and press "Clone"

![image](https://user-images.githubusercontent.com/104514709/183603880-92217d8a-bc99-4adf-b6d7-030096576090.png)


Step 4: You now have a copy of SharpBrowser! Press "Start" after you choose the system architecture
![image](https://user-images.githubusercontent.com/104514709/183604128-771daefc-6254-41bc-8660-2d28200a0b1e.png)