1 files changed, 53 insertions, 0 deletions
diff --git a/readme b/readme
new file mode 100755
index 0000000..b09f360
--- /dev/null
+++ b/readme
@@ -0,0 +1,53 @@
+In this directory are programs for facilitating
+practical and programatic updating of neocities
+web pages. The various files written in C are
+dedicated to the generation of HTML via the
+neocities API's JSON output. The various shell
+scripts are dedicated to downloading and
+uploading via that API.
+
+Each of 'composed.c', 'files.c',
+'drawn/monthly.c', and photographed/monthly.c
+may be interpreted by a C89 compiler, and
+the output program may be used to generate
+valid HTML. 'composed.c' is designed to
+generate a web page featuring musical works,
+requiring 'files.json' and files in 'lyrics'.
+'files.c' is designed to generate a map of a
+a neocities site, given the availability of
+'files.json'. 'drawn/monthly.c' is designed
+to generate a series of web pages featuring
+images, with each web page separated by
+month. 'photographed/monthly.c' is the same
+program as 'drawn/monthly.c', with different
+file paths programmed in.
+
+'update.sh' is dedicated to the direct
+interaction with the neocities API required
+for downloading 'files.json' or uploading
+content generated from 'files.json'.
+'./update.sh up' writes an updated copy of
+a given site's file to 'files.json'.
+./update.sh files' calls 'files', derivative
+of 'files.c', to generates 'files.html' from
+'files.json'. './update.sh up files drawn
+photographed composed' first updates
+'files.json', then calls each of the
+programs that may be generated from the
+previously mentioned files ending in '.c'
+to generate HTML derivative of the newly
+updated 'files.json', then uploads the
+newly generated HTML to neocities. Each of
+these actions may be issued via separate
+commands as desired.
+
+In the 'various' directory are various
+shell scripts, each of which may facilitate
+the uploading of manually generated content.
+For their specific uses, see
+'various/readme'.
+
+These programs are tailored for use with
+a specific neocities site; modification
+is required, only two of four batteries
+included.