add readme and license

This commit is contained in:
Ryan Barth 2021-07-24 23:59:32 -07:00
parent aaf3ac8846
commit f60787cc4c
2 changed files with 63 additions and 0 deletions

19
LICENSE Normal file
View File

@ -0,0 +1,19 @@
Copyright (c) 2021 Ryan Barth
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

44
README.md Normal file
View File

@ -0,0 +1,44 @@
# KDE Activity Browser
Launch a browser dependant on the current KDE activity in use.
## Usage
Before this script will be useful you will first need to setup the KDE
activities you want to use and create the corresponding browser profiles.
### Creating Profiles
**Firefox**
Navigate to [about:profiles](about:profiles) and click the "Create a new
profile" button to create a new profile. After you are done creating profiles
make sure the global default session is set using the "Set as default profile"
below the corresponding profile entry.
### Setting the default browser to use
```
activity-browser set-default-program firefox
```
### Setting the profile for the current activity
To set the profile to use for the activity switch to the activity you want to
change then open a terminal and run the following command.
```
activity-browser set-profile firefox work
```
This will set the Firefox browser to open the `work` profile for this activity
for now on. You can change the default profile at any time by rerunning the
command and specifying a different profile to use.
### Checking the settings
In a terminal run `activity-browser show-config` to check the current program
settings. The default storage location for the config file is
`$HOME/.config/activity-browser/config.json`
### Launching the browser
Activity browser will use the default browser to launch the profile specified
for the activity by default. Otherwise it will launch the default browser