diff options
| -rw-r--r-- | README | 24 | ||||
| -rw-r--r-- | docs/using.txt | 2 |
2 files changed, 4 insertions, 22 deletions
diff --git a/README b/README index e0e48f9..ae0980f 100644 --- a/README +++ b/README @@ -3,29 +3,9 @@ RELEASED. YOU HAVE BEEN WARNED! dscip: Dead Simple Continuous Integration POSIX ================================================================================ -Description: This is a script/daemon that scans a git repo for changes, and runs commands automatically. It's meant to be a dead simple alternative to services like Gitlab-ci and Jenkins. This script was also made to be as POSIX compliant as possible, so it should run on basically every platform with a POSIX shell. -================================================================================ -How To Use: - 1. Create a directory somewhere like /var/dscip/project_name. - 2. Copy all the files from dscip into that new directory. - 3. Open dscip in your text editor of choice and modify the variables to your - liking. - 4. Edit pre.sh, build.sh, and post.sh to fit your needs. - 5. Create a user for building. Like `dscip_user` or `project_name` - (Depends how separated you want to privileges to be.) - 6. Run chown -R <user> /var/dscip - So the new user owns it all. - Cron: - Add: * * * * * <user> /var/dscip/project_name/dscip - to your crontab. - Daemon: - Set DSCIP_DAEMON to true, and create an init script for it, and enable - it. -================================================================================ -To Do: - - Better daemon-mode capabilities. - - Better how-to instructions... + +Refer to the docs folder for how to use DSCIP. diff --git a/docs/using.txt b/docs/using.txt index 216e497..29dbbf3 100644 --- a/docs/using.txt +++ b/docs/using.txt @@ -13,5 +13,7 @@ by running `crontab -e -u build_user` and adding: 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. +Be sure to change the variables in config.sh to suit your projects needs. + Quirks: When running it on windows, you should use MSYS2. |