README.md (1208B)
1 # wf-install 2 3 ## `install.sh` 4 `install.sh` is a script to install and configure [Wayfire](https://wayfire.org) and related programs like [wf-shell](https://github.com/WayfireWM/wf-shell). 5 6 The general usage is: 7 8 ``` 9 git clone https://github.com/WayfireWM/wf-install 10 cd wf-install 11 12 ./install.sh --prefix /opt/wayfire --stream 0.7.x 13 ``` 14 15 The last script will download all necessary components and install them to the given prefix. 16 If you want to build the latest versions, use `--stream master`. 17 For Wayfire and wf-shell, default configuration files will also be installed to `$XDG_CONFIG_HOME/wayfire.ini` or `~/.config/wayfire.ini` 18 19 The script also has a few other options, which you can see by calling `./install.sh --help` 20 21 ## `update_build.sh` 22 23 `update_build.sh` is a script similar to `install.sh`, but assumes you have already built and installed Wayfire. 24 It will simply update the downloaded code, recompile and install it to the same prefix as configured with `install.sh`. 25 26 ``` 27 ./update_build.sh . 0.7.x 28 ``` 29 30 The first parameter is the toplevel directory where you started the build (i.e the folder with `wayfire`, `wf-shell` and `wcm` source), and the second one is the version of Wayfire to build.