diff options
| author | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2021-12-21 23:59:13 +0000 |
|---|---|---|
| committer | LMBishop <13875753+LMBishop@users.noreply.github.com> | 2021-12-21 23:59:13 +0000 |
| commit | a7967e0edc516233ebeb3a109c7b0d038db41e0d (patch) | |
| tree | ccbcc36e535f013b9a0d574d5e50ee9eacc9626b | |
| parent | 2e1ca45f2f13e2242f0c70c463ae86fd8c9929e0 (diff) | |
Update README
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -20,3 +20,19 @@ $ tsc && node build/index.js ``` The application will be listening on port 3000. + +## Caveats +This website is essentially built like a wiki system, though there are some drawbacks with this compared to actual wiki software, considering this is a highly specific use case of it. In no particular order: +* re-rendering pages are a pain after edits +* files are read from <code>/static/image</code> rather than <code>/pages/file</code> (which breaks the point of the entire namespace system) +* templates can't transclude other templates +* the Template namespace is the only transcludable namespace +* code is a bit wack in places +* I'm never happy with the visual design +* I don't actually know what to fill this website with +* I've written this list both on the website itself and in this readme so I will have to update it twice (and will likely forget one of them) + +## License +The **source code** for this project is licensed under the [ISC License](https://github.com/LMBishop/website/blob/master/LICENSE.txt). You can read the full license text in the [LICENSE.txt](https://github.com/LMBishop/website/blob/master/LICENSE.txt) file. + +Any media (images, binary files, videos), or any other non-source code in this repository do not fall under this license. |