1000fps/README.md
2025-07-20 12:43:43 +03:00

33 lines
1.2 KiB
Markdown

1000 FPS Grading System (v1.0)
===============================
This is the website source code for the 1000FPS grading system. `www/index.html`
is considered the ground truth for this system.
### Building
You need to have at least PHP 7 and composer installed on your system.
```sh
# Fetch dependencies
composer install
# Serve content using the built in php server.
DEBUG=1 php -S 0:8080 -t www
```
### Contributing
This website is not as serious as the tone of the actual document itself. If you
have any input feel free to shoot me a patch.
Any file you touch in `assets/` must be updated in `www/` manually. The SVG
files in `assets/` are intended to be edited using Inkscape. Otherwise, the
files in `www/` are intended to be served to the web.
In order to prepare an asset for the web, convert all text to paths and export
the file as a plain SVG. This ensures that the SVG image does not depend on any
system fonts and display well on all platforms, without any Inkscape specific
extensions to the file format.
### Why PHP?
This is the only web technology I know well enough to write this silly website
in. Don't port it to nodejs, I cannot read or write javascript for the life of
me. That's why I used minimal JS for this website.