enhance README.md

This commit is contained in:
Wolfgang Rumpler 2018-04-12 17:57:30 +02:00
parent f8c0e34aee
commit f29708ad78

View file

@ -6,33 +6,34 @@ Random Wallpapers for Gnome 3 is a gnome shell extension which fetches a random
![Screenshot](/assets/screenshot.png)
## Installation (symlink to repository)
Run `git clone git@github.com:ifl0w/RandomWallpaperGnome3.git` to clone the repository.
Run `./install.sh` to make a symbolic link from the extensions folder to the git repository.
Clone the repository and run `./install.sh` in the repository folder to make a symbolic link from the extensions folder to the git repository.
This installation will depend on the repository folder, so do not delete the cloned folder.
Then open the command prompt (Alt+F2) end enter `r` to restart the gnome session.
In the case you are using wayland, then no restart should be required.
Now you should be able to activate the extension through the gnome-tweak-tool.
__Installing this way has various advantages:__
* Switching between versions and branches.
* Updateing the extension with `git pull`
## Installation (manually)
Open the commandline and type the following lines:
Clone or download the repository and copy the folder `randomwallpaper@iflow.space` in the repository to `~/.local/share/gnome-shell/extensions/`.
```
git clone git@github.com:ifl0w/RandomWallpaperGnome3.git
cp -r RandomWallpaperGnome3/randomwallpaper@iflow.space ~/.local/share/gnome-shell/extensions/
```
Then open the command prompt (Alt+F2) end enter `r` to restart the gnome session.
In the case you are using wayland, then no restart should be required.
Then open the command prompt (Alt+F2) end enter `r` without qotes.
Now you should be able to activate the extension through the gnome-tweak-tool.
## Uninstall
Run `./install uninstall` to delete the symbolic link.
If you installed the extension manually you have to delete the extension folder with `rm -rf ~/.local/share/gnome-shell/extensions/randomwallpaper@iflow.space`.
If you installed the extension manually you have to delete the extension folder `randomwallpaper@iflow.space` in `~/.local/share/gnome-shell/extensions/`.
## Debugging
Extension output can be followed with `./debug.sh`. Information should be printed using the existing logger class but can also be printed with `global.log()` (not recommended).
To debug the prefs.js use `./debug.sh perfs`.
To debug the `prefs.js` use `./debug.sh perfs`.
## Compiling schemas
This can be done with the command: `glib-compile-schemas randomwallpaper@iflow.space/schemas/`