add install instructions to README

This commit is contained in:
Lynne Megido 2024-08-28 12:17:33 +10:00
parent 5cc3c1bf5f
commit 5c592aebd9
Signed by: lynnesbian
GPG key ID: F0A184B5213D9F90

View file

@ -3,21 +3,29 @@ lynnesbian.space
This is the Jekyll site directory for [lynnesbian.space](https://lynnesbian.space). I can't really see anyone getting
much use out of the source for the website, but there's not really a reason *not* to publish it, so whatever.
## Getting started
```bash
git clone https://git.bune.city/lynnesbian/lynnespace
cd lynnespace
gem install bundler
bundler install
```
## Licensing
This is gonna get complicated, but here goes:
- The provided HTML, JavaScript, and CSS files are licensed under the Expat license (aka the "MIT license").
- `favicon.ico` and `favicon.png` are both CC-BY-SA.
- All files in the `/_data` and `/_projects` directories are CC-BY-SA.
- All files in the `/_projects` directory are CC-BY-SA.
- All other files are Expat licensed.
- If files seem to be licensed under two licenses (my bad), assume Expat.
In other words: You can use the JavaScript, HTML, and CSS content of this website without attribution (although I would
prefer it if you did provide attribution). You can also do whatever you want with the files in `/_data` and
`/_projects`, but you must provide attribution for these files, and any derivative works made with them must also be
CC-BY-SA licensed.
prefer it if you did provide attribution). You can also do whatever you want with the files in `/_projects`, but you
must provide attribution for these files, and any derivative works made with them must also be CC-BY-SA licensed.
### Links to licenses used
- [CC-BY-SA](https://creativecommons.org/licenses/by-sa/4.0/legalcode)
- [Expat](https://spdx.org/licenses/MIT.html#licenseText)
- [Expat](https://spdx.org/licenses/MIT.html#licenseText)