From 8297af548994e43681b85e00b1bdb061959d9dd9 Mon Sep 17 00:00:00 2001 From: Charadon Date: Sat, 6 Aug 2022 12:38:20 -0400 Subject: Added some documentation --- docs/using.txt | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/using.txt (limited to 'docs/using.txt') 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. -- cgit 1.4.1-2-gfad0