mirrors/paceboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Documentation pass

Browse source
This commit is contained in:
Zachary Talis 2021-06-27 23:57:53 -04:00
parent ae8ba9ac7c
commit f3556f8078
4 changed files with 28 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,9 +1,30 @@
# paceboard
Simple leaderboard site template updated via Python scripts!
![Project logo, a sine wave forming gravestones in the negative space.](assets/img/logo.png)
Designed for use within speedrunning communities.
[Blog post]() - [Example site]()
## About
paceboard is a template-based static site generator for speedrunning leaderboards. Python scripts are used to add runs and categories, and all info is stored in `csv` files.
**paceboard** is a template-based static site generator for speedrun leaderboards.
You can configure site details, implement categories, and add runs all from a single Python script (`paceboard.py`).
Category and run information is stored in `csv` files for ease of access and editing.
## Instructions
This guide assumes that you know the basics of hosting your own website. Since paceboard is a *static* site generator, you can host via the free [GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-pages), assuming you know how to use [Git](https://git-scm.com/video/get-going).
Let's get started!
1. Make sure you have the latest version of [Python 3](https://wiki.python.org/moin/BeginnersGuide/Download).
2. [Download](https://github.com/PaceRIP/paceboard/archive/refs/heads/master.zip) or [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the paceboard repository.
3. Go to your install location via the command line, then run `python3 paceboard.py`. Follow the prompts to configure and auto-generate your site!
4. Discover you made a typo? Hop into the `csv` folder and you can manually edit the spreadsheets inside. Afterwards, running `python3 scripts/generate.py` will update your site with the new info.
## Template-based?
Within the `templates` folder are the [HTML](https://www.w3schools.com/html/html_intro.asp) files paceboard uses to format the site. If you're feeling intrepid, you can edit these templates to your liking.
During page generation, paceboard swaps out the `tk_` and `lk_` strings with their corresponding values in the database.

2
categories/README.md
View file

@ -1,3 +1,3 @@
# paceboard/categories
Directory for category pages created by `generate.py`, corresponding to entries in `categories.csv` and `runs.csv`.
Directory for category pages, corresponding to entries in `categories.csv`.

2
runs/README.md
View file

@ -1,3 +1,3 @@
# paceboard/runs
Directory for run pages created by `generate.py`, corresponding to entries in `runs.csv`.
Directory for run pages, corresponding to entries in `runs.csv`.

4
templates/README.md
View file

@ -3,5 +3,5 @@
Directory for template files used to generate:
* The index page
* The category pages
* The run pages
* `/categories`
* `/runs`