diff options
author | Charadon <dev@iotib.net> | 2022-10-05 17:13:47 -0400 |
---|---|---|
committer | Charadon <dev@iotib.net> | 2022-10-05 17:13:47 -0400 |
commit | 73733275044257f26d5e6cb01af739835482e737 (patch) | |
tree | 3b6d6dcf33bed20e6f19a882f736d41946273122 /docs | |
parent | f60854800d6f8d8ddff9afe35b9c098d7b4dd3ba (diff) | |
download | dscip-73733275044257f26d5e6cb01af739835482e737.tar.gz |
Remove old docs/ folder, as the GNU Info manual has already surpassed it.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/packaging.txt | 41 | ||||
-rw-r--r-- | docs/publishing.txt | 13 | ||||
-rw-r--r-- | docs/setup.sh.txt | 6 | ||||
-rw-r--r-- | docs/templates.txt | 22 | ||||
-rw-r--r-- | docs/using.txt | 19 | ||||
-rw-r--r-- | docs/variables.txt | 6 |
6 files changed, 0 insertions, 107 deletions
diff --git a/docs/packaging.txt b/docs/packaging.txt deleted file mode 100644 index 0a40749..0000000 --- a/docs/packaging.txt +++ /dev/null @@ -1,41 +0,0 @@ -My personal recommended way to package DSCIP is to do the following: - -Install all the scripts except setup.sh into /usr/share/charadon/dscip. -Next, install setup.sh to /usr/bin/setup-dscip. -Optionally, you can remove update.sh, if you wish for the user *not* to be -able to update dscip on their own outside of the packaging system. -And install the docs to your system's recommended documentation directory. -(Usually /usr/share/doc, or /usr/doc) - -If it's installed this way, instead of grabbing DSCIP from the remote git -repo, the setup script will copy the files from /usr/share/charadon/dscip. - -It requires no additional dependencies if I did things right, as it's written -in complete POSIX shell. Though, on illumos, it'll probably need GNU Coreutils -for realpath support. - -This is roughly what a package tree should look like. This is based on my -SlackBuild for Slackware. - -usr -├── bin -│ └── setup-dscip (setup.sh) -├── doc -│ └── dscip-0.9 -│ ├── LICENSE -│ ├── dscip.SlackBuild -│ ├── packaging.txt -│ ├── publishing.txt -│ ├── setup.sh.txt -│ ├── templates.txt -│ ├── using.txt -│ └── variables.txt -└── share - └── charadon - └── dscip - ├── build.sh - ├── config.sh - ├── dscip - ├── failed.sh - ├── post.sh - └── pre.sh diff --git a/docs/publishing.txt b/docs/publishing.txt deleted file mode 100644 index c3cf15c..0000000 --- a/docs/publishing.txt +++ /dev/null @@ -1,13 +0,0 @@ -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/setup.sh.txt b/docs/setup.sh.txt deleted file mode 100644 index f0699ba..0000000 --- a/docs/setup.sh.txt +++ /dev/null @@ -1,6 +0,0 @@ -setup.sh is a script that helps automate or more easily set up a dscip -instance. If it is ran without arguments it enters Interactive Mode, where it -will prompt you questions. - -However, it can be used with command-line switches in Non-Interactive Mode. -For more info, use the -h switch on setup.sh diff --git a/docs/templates.txt b/docs/templates.txt deleted file mode 100644 index c28aecc..0000000 --- a/docs/templates.txt +++ /dev/null @@ -1,22 +0,0 @@ -In the setup script, you can specify a directory that contains templates. - -This directory can contain: -pre.sh -post.sh -build.sh -failed.sh -config.sh - -This can be helpful if you have multiple projects that build pretty much -exactly the same. Or are extremely similar and only require small -modifications, rather than writing the entire scripts from scratch. - -When using the setup.sh script, you can specify the directory by using --t /path/to/templates. A template directory looks like this: - -templates/ -├── build.sh -├── failed.sh -├── post.sh -├── config.sh -└── pre.sh diff --git a/docs/using.txt b/docs/using.txt deleted file mode 100644 index 29dbbf3..0000000 --- a/docs/using.txt +++ /dev/null @@ -1,19 +0,0 @@ -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. - -Be sure to change the variables in config.sh to suit your projects needs. - -Quirks: -When running it on windows, you should use MSYS2. diff --git a/docs/variables.txt b/docs/variables.txt deleted file mode 100644 index 38e8f4e..0000000 --- a/docs/variables.txt +++ /dev/null @@ -1,6 +0,0 @@ -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. |