Add instructions for hosting on GitHub pages

Tulir Asokan 2020-09-17 14:13:20 +03:00
parent c8f4e527e9
commit ff50c858c0

@ -0,0 +1,15 @@
If you don't have a webserver to run the files on, you can also use something like GitHub pages.
1. Fork the repo
![arrow pointing at fork button](https://mau.photos/oQRHL.png)
2. Go to settings
![arrow pointing at settings button](https://mau.photos/dVLlz.png)
3. Scroll down to the bottom to the "GitHub Pages" section"
4. In the "Source" dropdown, select "master"
![arrow pointing at branch dropdown in GH pages settings](https://mau.photos/D2wOf.png)
5. Click "Save"
![arrow pointing at save button](https://mau.photos/C16js.png)
6. Clone your fork (`git clone git@github.com:username/stickerpicker.git`)
7. Follow the instructions in [Creating packs](https://github.com/maunium/stickerpicker/wiki/Creating-packs) to create packs
8. Commit your changes (`git add web/packs && git commit`) and push (`git push`)
9. Follow the instructions in [Enabling the widget](https://github.com/maunium/stickerpicker/wiki/Enabling-the-widget) using `https://username.github.io/stickerpicker/web/?theme=$theme` as the `url` field.