privsec.dev/README.md

# PrivSec.dev

_\~&ensp;A practical approach to Privacy and Security&ensp;\~_

[![Netlify Status](https://api.netlify.com/api/v1/badges/ba0d8ddc-031b-4c16-8240-9929a4ad201a/deploy-status)](https://app.netlify.com/sites/privsec-dev/deploys)

## Licensing

Prospective contributors are encouraged to review [CONTRIBUTING.md](/CONTRIBUTING.md) and the [Contributor License Agreement](https://github.com/PrivSec-dev/contributor-license-agreement).

Posts are licensed under the [Creative&nbsp;Commons Attribution&#8209;ShareAlike&nbsp;4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). _Please make sure to attribute the author(s) properly and include a link to the original publication when applicable._

[Hugo](https://gohugo.io/), the static site generator used to build the site, is licensed under the [Apache&nbsp;License&nbsp;2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).

The [WonderMod](https://github.com/Wonderfall/hugo-WonderMod) theme (and its upstream [PaperMod](https://github.com/adityatelange/hugo-PaperMod)) is licensed under the [MIT&nbsp;License](https://github.com/Wonderfall/hugo-WonderMod/blob/master/LICENSE). Except where otherwise noted, PrivSec.dev's modifications to WonderMod are also licensed under the MIT&nbsp;License.

## Hosting (Netlify)

The https://privsec.dev website is hosted by [Netlify](https://netlify.com). Netlify will automatically generate previews for pull requests and on pull request updates.

## Local Working Environment

1. Install [Git](https://git-scm.com/downloads) and [Hugo](https://gohugo.io/getting-started/installing/).
   - Most users should simply use the [self&#8209;contained Hugo executable for their platform](https://github.com/gohugoio/hugo/releases). Linux package managers often provide old versions of Hugo.
1. Clone this repository: `git clone --recurse-submodules https://github.com/PrivSec-dev/privsec.dev`.
1. Run `hugo serve` to start the local development server at (by default) `http://localhost:1313`.
   - Alternatively run `hugo` to simply build the site into the `public/` directory.

- Run `git submodule update --merge` to update the [WonderMod theme](https://github.com/Wonderfall/hugo-WonderMod) to the version specified in this repo.
  - Run `git submodule update --remote --merge` to update to the upstream master branch of WonderMod.
- Run `./external-blogs.sh` to pull the latest versions of certain posts from their canonical (external) sources.
Add more instructions Signed-off-by: Tommy <contact@tommytran.io> 2022-07-22 00:55:11 -04:00			`# PrivSec.dev`
Netlify Badge Signed-off-by: Tommy <contact@tommytran.io> 2022-07-22 00:45:14 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`_\~&ensp;A practical approach to Privacy and Security&ensp;\~_`
Update README.md Signed-off-by: Tommy <contact@tommytran.io> 2022-11-22 01:23:21 -05:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`[![Netlify Status](https://api.netlify.com/api/v1/badges/ba0d8ddc-031b-4c16-8240-9929a4ad201a/deploy-status)](https://app.netlify.com/sites/privsec-dev/deploys)`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`## Licensing`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contributor License Agreement moved to separate repo (#107) 2023-01-22 08:16:11 -05:00			`Prospective contributors are encouraged to review [CONTRIBUTING.md](/CONTRIBUTING.md) and the [Contributor License Agreement](https://github.com/PrivSec-dev/contributor-license-agreement).`
Clarify Contributor License Signed-off-by: Tommy <contact@tommytran.io> 2022-10-21 22:57:01 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`Posts are licensed under the [Creative Commons Attribution‑ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/). _Please make sure to attribute the author(s) properly and include a link to the original publication when applicable._`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`[Hugo](https://gohugo.io/), the static site generator used to build the site, is licensed under the [Apache License 2.0](https://github.com/gohugoio/hugo/blob/master/LICENSE).`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`The [WonderMod](https://github.com/Wonderfall/hugo-WonderMod) theme (and its upstream [PaperMod](https://github.com/adityatelange/hugo-PaperMod)) is licensed under the [MIT License](https://github.com/Wonderfall/hugo-WonderMod/blob/master/LICENSE). Except where otherwise noted, PrivSec.dev's modifications to WonderMod are also licensed under the MIT License.`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`## Hosting (Netlify)`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`The https://privsec.dev website is hosted by [Netlify](https://netlify.com). Netlify will automatically generate previews for pull requests and on pull request updates.`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`## Local Working Environment`
Add Licensing and Development information 2022-07-22 00:38:53 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			`1. Install [Git](https://git-scm.com/downloads) and [Hugo](https://gohugo.io/getting-started/installing/).`
			`- Most users should simply use the [self‑contained Hugo executable for their platform](https://github.com/gohugoio/hugo/releases). Linux package managers often provide old versions of Hugo.`
			1. Clone this repository: `git clone --recurse-submodules https://github.com/PrivSec-dev/privsec.dev`.
			1. Run `hugo serve` to start the local development server at (by default) `http://localhost:1313`.
			- Alternatively run `hugo` to simply build the site into the `public/` directory.
Update local development instructions (README.md) (#29) Signed-off-by: WfKe9vLwSvv7rN <96372288+WfKe9vLwSvv7rN@users.noreply.github.com> 2022-07-24 05:43:59 -04:00
Contribution guidelines and CLA (#92) 2023-01-15 05:00:43 -05:00			- Run `git submodule update --merge` to update the [WonderMod theme](https://github.com/Wonderfall/hugo-WonderMod) to the version specified in this repo.
			- Run `git submodule update --remote --merge` to update to the upstream master branch of WonderMod.
			- Run `./external-blogs.sh` to pull the latest versions of certain posts from their canonical (external) sources.