Eunakria
46f9a5665e
* Localize "file" and "link" in OGP title * Correct `dist/i18n.yml` to `res/i18n.yml` in README
48 lines
2.9 KiB
Markdown
48 lines
2.9 KiB
Markdown
# `ln -s`
|
|
|
|
> *Because you can't remember which way round it goes either, can you?*
|
|
|
|
## Table of Contents
|
|
|
|
* [Introduction](#introduction)
|
|
* [Building](#building)
|
|
* [License](#license)
|
|
|
|
## Introduction
|
|
|
|
I made this website in all of 20 minutes and don't have any particular affection towards it. It's an overengineered poster to help clear up a bad design decision made years ago by people who are both smarter than me, and who I do not know. This website has an entirety of three sentences of text and a single image, and no delusions of grandeur.
|
|
|
|
To that extent, I am releasing it into the [**public domain**](https://creativecommons.org/public-domain/cc0/). Feel free to use it, fork it, copy it, share it, or whatever else you like. If you do make something cool with it, I'd love to see it, so please let me know!
|
|
|
|
**Translations and bug fixes are welcome,** and can be submitted as pull requests. Translations are stored in the YAML file `res/i18n.yml`. See [Building](#building) for instructions on how to build the site. If you have any questions, feel free to reach out to me (`@eunakria` on Discord)!
|
|
|
|
**Bug reports are also welcome,** and can be submitted as issues on the official [Git repository](https://git.eunakria.com/Eunakria/ln-s). (You might see the code mirrored elsewhere, e.g. on GitHub, but I don't check those repositories for issues or pull requests.)
|
|
|
|
## Building
|
|
|
|
To build the site, you will need to have [Python](https://www.python.org/) installed, as well as the [Make](https://www.gnu.org/software/make/) utility. (GNU-flavored, ideally, but it might work on POSIX systems as well.) Once you have those installed, run the following commands:
|
|
|
|
```bash
|
|
# First create a virtual environment, if you haven't already.
|
|
# This is optional, but recommended to avoid polluting your global
|
|
# Python environment.
|
|
python -m venv .venv
|
|
source .venv/bin/activate # On Windows, use `.venv\Scripts\activate`
|
|
|
|
# Then install the required dependencies and build the site.
|
|
pip install -r requirements.txt
|
|
make
|
|
```
|
|
|
|
The site will be built into the `dist/` directory.
|
|
|
|
## License
|
|
|
|
The project itself is provided under the [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/public-domain/zero/1.0/legalcode). This means you can do whatever you like with it, including using it in commercial projects, without needing to give credit.
|
|
|
|
Some third-party assets are vendored in the `vendor/` directory, and may be provided under different licenses. A list of these assets and their licenses follows:
|
|
|
|
* [**Caveat Brush**](https://fonts.google.com/specimen/Caveat+Brush) (font) by Impallari Type is provided under the [SIL Open Font License 1.1](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL_web).
|
|
|
|
* [**Recursive**](https://www.recursive.design/) (font) by Arrow Type is provided under the [SIL Open Font License 1.1](https://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=OFL_web).
|