Added some documentation

3 files changed, 36 insertions, 0 deletions

diff --git a/docs/publishing.txt b/docs/publishing.txt
new file mode 100644
index 0000000..c3cf15c
--- /dev/null
+++ b/docs/publishing.txt
@@ -0,0 +1,13 @@
+Publishing build artifacts and logs.
+================================================================================
+There are many ways you can publish artifacts, both privately and publically.
+
+Methods include:
+Sending logs/artifacts through e-mail.
+Uploading logs/artifacts to an FTP server.
+Uploading logs/artifacts to an rsync server.
+Uploading it through good ol HTTP.
+
+Basically, if there's a commandline utility for it, you can use it in the
+post/failed.sh scripts. Refer to variables.txt for how to use variables for
+organizing artifacts.
diff --git a/docs/using.txt b/docs/using.txt
new file mode 100644
index 0000000..216e497
--- /dev/null
+++ b/docs/using.txt
@@ -0,0 +1,17 @@
+Using DSCIP
+================================================================================
+Using DSCIP is extremely simple, there's two ways you can run it.
+A. Running it as a cronjob that runs periodically.
+B. Running it as a daemon that runs continually.
+
+Funcionally, these two methods work about the same, but depending on your
+platform, one may be easier to set up than the other. I personally recommend
+setting it up as a cronjob over a daemon. You can do this on most unix systems
+by running `crontab -e -u build_user` and adding:
+* * * * * /home/build_user/program/dscip
+
+As for how to make it run as a daemon, that depends on the platform you are
+running it on, so refer to your OS's documentation for that.
+
+Quirks:
+When running it on windows, you should use MSYS2.
diff --git a/docs/variables.txt b/docs/variables.txt
new file mode 100644
index 0000000..38e8f4e
--- /dev/null
+++ b/docs/variables.txt
@@ -0,0 +1,6 @@
+Using Variables in the Build Scripts
+================================================================================
+Every environment variable found in config.sh and the main dscip script can be
+used in your build scripts. For example, you can use $CURRENT_COMMIT to create
+a folder on your FTP server to put outputs into. Refer to the post.sh defaults
+to see an example.