From 1bedd143c4b577bd0c6bcc295c65feea653b5463 Mon Sep 17 00:00:00 2001 From: Tommy Date: Fri, 22 Jul 2022 00:38:53 -0400 Subject: [PATCH] Add Licensing and Development information --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index aa38792..f5d48ba 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # privsec.dev A practical approach to Privacy and Security + +# Licensing + +The website content (under `/content`) is under the [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license. + +The articles originally posted on [wonderfall.dev](https://wonderfall.dev) are under the same license. + +The Hugo Framework used to create this website is under the [Apache License](https://github.com/gohugoio/hugo/blob/master/LICENSE). + +The PaperMod theme used for the website and modifications made by us are under the [MIT License](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE). + +# Netlify Previews: + +We use Netlify to host our website and generate previews. Simply add your articles inside of /content or make any modifications that you want, open a new Pull Request and a preview page will be generated for you automatically. + +# Local Development: + +1. git clone this repository `git clone https://github.com/PrivSec-dev/privsec.dev` +2. [Install Hugo](https://github.com/PrivSec-dev/privsec.dev) +3. Run `hugo serve`. The local version of the website should be available at `http://127.0.0.1:1313`. \ No newline at end of file