-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
Docs brush up #159
Docs brush up #159
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,16 @@ | ||
# Hurl Extension | ||
# Hurl browser extension | ||
|
||
This browser extension uses Native Messaging API to communicate with the Hurl Application. | ||
|
||
## Installation | ||
|
||
To use it in Chrome, follow the steps below: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These steps seem to be seriously outdated? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I updated them recently. If anything, I might have missed on adding a step in middle. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think I know why I can't find Dev Mode - I already have it on 😆 |
||
|
||
- Enable the Developer Mode for Extensions in Chrome | ||
- Choose the folder `{installationDir}/Extensions/Chrome` after clicking `Load Unpacked` Button available after enabling Developer mode | ||
- Enable the Developer Mode for Extensions in Chrome ([instructions on Chromium blog](https://blog.chromium.org/2009/06/developer-tools-for-google-chrome.html)) | ||
- Select **Load Unpacked** | ||
- Choose the folder `{installationDir}/Extensions/Chrome` | ||
|
||
Run the `install-nmh.ps1` script as admin located in `{installationDir}/Extensions` after installing the extension. Also Get the extension id from the extension page in Chrome. | ||
Run the `install-nmh.ps1` script as admin located in `{installationDir}/Extensions` after installing the extension. Also get the extension id from the extension page in Chrome. | ||
|
||
```powershell | ||
cd {installationDir} | ||
|
@@ -18,4 +19,4 @@ cd {installationDir} | |
|
||
You can modify the script to use it for other chromium-based browsers by editing the REG command in it and pointing to appropriate browser's registry key for Native Messaging Hosts. | ||
|
||
During **Development**, Use the `dir_where_Launcher.exe_is` to point to the directory where the `Launcher.exe` is located (usually to `Source/Launcher/target/debug`). | ||
During **Development**, use the `dir_where_Launcher.exe_is` to point to the directory where the _Launcher.exe_ is located (usually to `Source/Launcher/target/debug`). |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
<img width="150" align="left" src="Source/Hurl.BrowserSelector/Assets/internet.ico"> | ||
# Hurl | ||
|
||
<h1 align="center">Hurl</h1> | ||
A Windows utility that lets you choose a browser on the click of a link. | ||
|
||
<p align="center">A windows utility that lets you choose a browser on the click of a link</p> | ||
![Hurl Icon](Source/Hurl.BrowserSelector/Assets/internet.ico) | ||
Comment on lines
+1
to
+5
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I prefer the Icon/Logo is either centered or in a two column layout as it was previously. So you can leave it as it was earlier. but open to any suggestions here There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. By default, all text in Markdown fields are aligned to the left. A Markdown image inside HTML tags does not work. In general, HTML is unrecommended anyway. More info: https://github.github.com/gfm/#html-blocks Compare these imagesNotice the second URI isn't underlined and how hovering over it doesn't offer to open the file. The result is: Options
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's currently go with 3 (I made additional few tweaks) for now. And will come back to 2. later once we have a fresh icon for hurl |
||
|
||
<p align="center"> | ||
<a style="text-decoration:none" href="https://github.com/U-C-S/Hurl/releases"> | ||
|
@@ -19,59 +19,58 @@ | |
</a> | ||
</p> | ||
|
||
> [!NOTE] | ||
> This software is currently in pre-v1.0 version, which means it can frequently introduce breaking changes with new versions. | ||
|
||
## Why and What? | ||
## Why and what? | ||
|
||
Sometimes you might want to open a link in a browser of your choice, instead of the default one. Hurl can let you choose the browser eachtime you click a link (links outside of browser). So naturally, It acts as default browser to do that. And hurl can be powered up with a _browser extension_ to let you open a browser tab in different browser. | ||
Sometimes you might want to open a link in a browser of your choice, instead of the default one. Hurl lets you choose the browser each time you click a link (links outside of browsers). So naturally, it acts as default browser to do that. | ||
Hurl can be powered up with a _browser extension_ to let you open a browser tab in a different browser. | ||
|
||
- Modern Windows UI with Multiple Customization Options | ||
- Supports adding own browser config with Launch Arguments | ||
- Modern Windows UI with multiple customization options | ||
- Supports adding own browser configuration with Launch Arguments | ||
- Rules to automatically open a browser without prompting | ||
- Settings application to manage all the features (beta) | ||
- Web Extension to open browser tabs in Hurl (experimental) | ||
|
||
<p align="center"> | ||
<img width="720" src="https://github.com/user-attachments/assets/dc4cc718-abf8-4032-9ef9-df832a1d059b" /> | ||
<!--<img width="720" src="" />--> | ||
<!--https://github.com/user-attachments/assets/7b3418fb-38e1-4259-85c6-11603c6eec7d--> | ||
<!--<img width="720" src="https://user-images.githubusercontent.com/50218121/230982396-152a2342-f02a-47c0-9349-3d1a4920554f.png" />--> | ||
<!--<img width="720" src="https://user-images.githubusercontent.com/50218121/198988257-7f89288c-7fd4-4bf3-8d7f-b5501d81ac61.png" />--> | ||
<!--<img width="640" src="https://user-images.githubusercontent.com/50218121/158625754-78026dbe-cd99-4078-8407-313b9c548ca1.png" />--> | ||
<!--<img width="640" src="https://user-images.githubusercontent.com/50218121/157494232-a134a412-9dd7-4706-8be7-6e3800484082.png" />--> | ||
</p> | ||
![MainWindow](Docs/Images/HurlMainwindow.png) | ||
|
||
> As a Web-Developer, Web-Surfer and someone who uses 3 browsers, Hurl is a bliss | ||
|
||
~ Me, probably | ||
|
||
> As a Web-Developer, Web-Surfer and someone who uses 3 browsers, Hurl is a bliss - Me probably | ||
## Installation and usage | ||
|
||
## Installation & Usage | ||
Download and install the latest versions of: | ||
|
||
Download and Install the latest versions of | ||
- [.NET 8 Desktop Runtime](https://dotnet.microsoft.com/download/dotnet/8.0) | ||
- Windows App Runtime v1.5 [Direct Download Link](https://aka.ms/windowsappsdk/1.5/latest/windowsappruntimeinstall-x64.exe) | ||
- [Hurl_Installer](https://github.com/U-C-S/Hurl/releases/latest) | ||
|
||
Get the Hurl_Installer from [Releases](https://github.com/U-C-S/Hurl/releases/latest) and Install it. | ||
> [!TIP] | ||
> It is recommended to uninstall your current version before installing a new version. | ||
|
||
Lastly, After installing, Make sure to set Hurl as the default `http/https` protocol handler in the Windows Settings ( For Windows 11, `Settings > Apps > Defualt apps > Hurl`), just like how you change the default browser. | ||
After installing, make sure to set Hurl as the default `http/https` protocol handler in the Windows Settings. In Windows 11: **Settings** > **Apps** > **Default apps** > **Hurl** > **Set as standard browser**. | ||
|
||
> Check out [Hurl Wiki](https://github.com/U-C-S/Hurl/wiki/) for more details on usage and configuration. And [Extensions/README.md](./Extensions/README.md) for installing the Browser Extension. | ||
Go to [Hurl Wiki](https://github.com/U-C-S/Hurl/wiki/) for more details on usage and configuration. See [Extensions readme](./Extensions/README.md) for installing the Browser Extension. | ||
|
||
## Building from Source / Local Development | ||
## Building from source / local development | ||
|
||
- Install Visual Studio 2022 with following workloads | ||
- Install [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) with following workloads: | ||
- .NET desktop development | ||
- Windows application development | ||
- Desktop development with C++ (required for building Launcher) | ||
- After Cloning the Repo, Open the solution file `./Hurl.sln` in Visual Studio. You can change the projects between Hurl.BrowserSelector and Hurl.Settings | ||
- After forking and cloning the repository, open the solution file `./Hurl.sln` in Visual Studio. You can change the projects between _Hurl.BrowserSelector_ and _Hurl.Settings_ | ||
- Install [Rustup / Setup Rust complier](https://www.rust-lang.org/tools/install) locally to debug Launcher app | ||
- Install Inno Setup, to create the Hurl Installer | ||
- Install [Inno Setup](https://jrsoftware.org/isdl.php) to create the Hurl Installer | ||
|
||
Use the Build Script from `Utils/build.ps1` to build the Application in release mode and successively build the installer. Make sure you have all the tools installed mentioned in the above description. | ||
Use the Build Script from `Utils/build.ps1` to build the application in _Release_ mode and build the installer. Make sure you have all the tools installed mentioned in the above description. | ||
|
||
To check out older versions source code, Use the [Github Tags](https://github.com/U-C-S/Hurl/tags). | ||
To check out older versions source code, go to [Github Tags](https://github.com/U-C-S/Hurl/tags). | ||
|
||
## Contributing | ||
|
||
The Project is open to Pull-Requests and Feedback. MIT License. | ||
The project is open to Pull-Requests and Feedback. MIT License. | ||
|
||
## Credits | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be looked at: do you show or hide the border? And is it even there in the latest UI?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, the one around the select browser window
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean: true = show or true = hide?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I see, I worded it confusing.
true=hide