about summary refs log tree commit diff stats
path: root/docs/using.txt
diff options
context:
space:
mode:
authorCharadon <dev@iotib.net>2022-08-06 12:38:20 -0400
committerCharadon <dev@iotib.net>2022-08-06 12:38:20 -0400
commit8297af548994e43681b85e00b1bdb061959d9dd9 (patch)
treefc93d9196d19ad0702d5ab37267076917fedd423 /docs/using.txt
parent9df670eeb430f92da25d6dd0f0c8874703e1feb0 (diff)
downloaddscip-8297af548994e43681b85e00b1bdb061959d9dd9.tar.gz
Added some documentation
Diffstat (limited to 'docs/using.txt')
-rw-r--r--docs/using.txt17
1 files changed, 17 insertions, 0 deletions
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.