From ff76322a8237ac71f9bb16efdac2225515078d12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?tr=C3=A9meur?= Date: Wed, 19 Jun 2024 16:34:40 +0100 Subject: [PATCH] Readme clarifications --- README.org | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.org b/README.org index 529af8c..de4e97a 100644 --- a/README.org +++ b/README.org @@ -1,11 +1,15 @@ #+TITLE: Trackers +* About +The scripts in this repository take information from a structured set of =.org= files and use them to build static webpages that track various activities (so far, gaming and travelling). These pages can be used as a replacement for third-party services e.g. Backloggery. * Dependencies - =python3= - =orgparse= (install via pip) - =rclone= (for syncing to the server) * General setup -*** Setting the variables +** Structure of the .org files +See =demo.org= for an example. +** Setting the variables Rename =variables-template.py= to =variables.py= and edit: - =orgpath=: absolute path to the root directory in which =.org= files are stored, including trailing slash - =localpath=: absolute path to this directory, including trailing slash @@ -14,7 +18,7 @@ Rename =variables-template.py= to =variables.py= and edit: * Tracking games with a backloggery clone ** Setup *** Fonts -Upload the fonts Lato, Titillium Web, and Material Icons to the directory =/fonts= on your server (I recommend [[https://gwfh.mranftl.com/fonts][google-webfonts-helper]]). Check the filenames are consistent with those in =build/backloggery.css=. Alternatively, you can load the fonts remotely and adjust the page head HTML generated by =skeleton.py=. +Upload the fonts Lato, Titillium Web, and Material Icons to the directory =/fonts= on your server (I recommend [[https://gwfh.mranftl.com/fonts][google-webfonts-helper]]). Check the filenames are consistent with those in =gamebuild/backloggery.css=. Alternatively, you can load the fonts remotely and adjust the page head HTML generated by =gameskel.py=. *** Setting the variables In =variables.py=, edit: - =trackgames=: set to =True= @@ -34,7 +38,10 @@ In =variables.py=, edit: - =trackplaces=: set to =True= - =placeserverpath=: path to directory on the server where files will be uploaded, including trailing slash - =placestartyear=: year from which to begin tracking (an integer) -- =placecss=: location of the CSS file, relative to the site root +- =placecss=: location of the CSS file you wish to apply, relative to the site root +** Testing +- Run =python3 generateplaces.py local= to build in =placebuild=. +- If new places have been added since the last build, they will be added to =places.py= and the terminal will signal this. Add the latitude and longitude for these places in =places.py= before building again. * First run (or if adding any new trackers) - Run =python3 init.py= and then =chmod +x build.sh=. - Create directories on the server corresponding to any =*serverpath= variables you have set.