From d2a2c673d40825e68dae9852ec8d072bd7c5f00c Mon Sep 17 00:00:00 2001 From: raoulvdberge Date: Sun, 24 Dec 2023 10:27:43 +0100 Subject: [PATCH] Update README, re-add LICENSE --- LICENSE.md | 24 ++++++++++++++++++++++++ README.md | 9 +++++++++ 2 files changed, 33 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000000..3e91b15f985 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,24 @@ +# The MIT License (MIT) + +Copyright © 2023 Refined Mods + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the “Software”), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index a1f1b0fb9cb..06c046a7726 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,13 @@ This is the repository that contains [the website](https://refinedmods.com) of Refined Mods. +The website is built and published twice a day. + This uses [refinedsites](https://github.com/refinedmods/refinedsites), a static site generator. + +## Building locally + +- Create an `.env` file containing a `GITHUB_TOKEN` environment variable. +- Run `build-local.sh`. +- The output will be in the `output/` folder. +- (Optional) Convert the `output/` folder to a styled website by running `npm run build` (run `npm install` first).