diff options
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 63 |
1 files changed, 49 insertions, 14 deletions
@@ -1,11 +1,13 @@ # fun memory violations -This is my website, running at [spacekookie.de](https://spacekookie.de). -It's built with Pelican and my own theme called `crumbs` (because kookies...). +This is my website, running at https://spacekookie.de. +It's built with Pelican and my own theme, +called `crumbs` (because kookies...). -To understand the theme, you need to understand jinja because it's not very linear. -Every sub-component is structured as such and then included. -Sometimes parameters are given to the sub-component to distinguish between different page behaviour. +The theme itself is pretty non-linear and uses a lot of sub-components +that are included from multiple files to generate HTML as needed. +This way there's not a lot of direct inheritence between templates, +but rather "behaviours", that are included into coherent pages. If you have questions, just ask :) @@ -13,24 +15,57 @@ There's a ["permadraft"] folder of articles that never quite made it. Some of them are farely fleshed out but either the time to publish them passed or I otherwise thought it'd be a bad idea ot put them on the blog. -["permadraft"]: https://github.com/spacekookie/website/tree/master/content/permadraft - -Their HTML pages are still being built, but not included in any index. -Feel free to hot-link to them if you like! +Their HTML pages are still being built and published, +but not included in any index page (like `blog`). +If you can find one, feel free to hot-link to it. ## How to build -You need to have python3 (not sure if it works with python2...) installed. -Then you can build the website as follows... +The easiest way to build the website is with [nix]. +Simply run `nix-shell` in this directory to install require dependencies. +Then you can use `make` to get access to a whole bunch of website +commands, such as `build`, or `devserver`. +The dev server is hosted on port 8000. + +**Manual install** + +If you don't use nix, you need to install `python3` and `pip`. +The python dependencies are `pelican`, `markdown` and `webassets`. +Please for the love of god use a `virtualenv` 😬. ```bash pip install pelican markdown webassets pelican content make devserver -# The server is hosted on port 8000 ``` -There's also a [nix] package over at [kookiepkgs] if you want to see the reproducible build. +## How to contribute + +This repository has recently moved from Github to [sourcehut]. +And while I will still (infrequently) mirror the repository to github, +I don't want to accept contributions there anymore. + +I have a [meta issue tracker][tracker], where you can post issues about +any of my projects, [in theory, without requiring registration][bug]. +Alternatively, you can send me a patch via e-mail either to my personal +address, or to my [public-inbox]. +["permadraft"]: /~spacekookie/website/tree/master/content/permadraft [nix]: https://nixos.org/nix -[kookiepkgs]: https://github.com/spacekookie/kookiepkgs/blob/master/pkgs/spacekookie-de/default.nix
\ No newline at end of file +[sourcehut]: https://git.sr.ht/~spacekookie/website +[tracker]: https://todo.sr.ht/~spacekookie/meta +[bug]: https://todo.sr.ht/~sircmpwn/todo.sr.ht/103 +[public-inbox]: https://lists.sr.ht/~spacekookie/public-inbox + +## License + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the +Free Software Foundation, either version 3 of the License, +or (at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. + |