summaryrefslogtreecommitdiff
path: root/various/neoup/readme
diff options
context:
space:
mode:
Diffstat (limited to 'various/neoup/readme')
-rw-r--r--various/neoup/readme29
1 files changed, 29 insertions, 0 deletions
diff --git a/various/neoup/readme b/various/neoup/readme
new file mode 100644
index 0000000..992928b
--- /dev/null
+++ b/various/neoup/readme
@@ -0,0 +1,29 @@
+The files provided here allow for generating a program that, when specified
+with valid credentials at compilation time, may be used to upload to a file
+or directory to a neocities site. The provided makefile's defaults are suitable
+for a usual mingw installation, and the commented-out alternatives are suitable
+for a usual Unix C89 compiler. In order to make this program work, fill in
+valid neocities log-in information in "config.h", compile by means of "make",
+and then run the program, that which has the following input syntax:
+
+ neoup [-r neocities directory] [-d local file or directory]
+
+Should a local file be supplied, it will be uploaded.
+Should a local directory be supplied, it and its contents will be uploaded.
+If none is specified, the current local directory's contents are uploaded.
+Should a neocities directory be specified, all uploads will be placed in that
+directory on the neocities site, relative to the starting directory.
+If none is specified, all uploads are placed in the starting directory.
+
+On Windows, mingw is the only build dependency that doesn't commonly come with
+the operating system.
+On Unix, there are no unusual build dependencies.
+On Windows, all of the run-time dependencies are already installed.
+On Unix, "curl" may need to be installed, depending on who distributes your
+operating system.
+
+Should there be an issue, message me.
+
+ kaa@disroot.org
+
+This author places their work distributed here in the Public Domain.