Initial commit

1 files changed, 107 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d98e78b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,107 @@
+# Slack Autoupdate
+
+Update your Slackware system automatically by integrating these customizable
+bash scripts.
+
+Pending update information is saved into the 'info' and 'error' text files
+under '/var/spool/slackware-autoupdate'. 'info.txt' should contain package
+update information, and 'error.txt' contains any problems encountered while
+attempting to source updates.
+
+## Support
+
+These scripts only currently support stable releases (sorry -current).
+
+## Installation and Configuration
+
+There are three components. the [cron script](./src/autoupdate) which downloads
+packages, the [rc.update script](./src/rc.update) which installs the packages, and
+the [install-kernel script](./src/install-kernel) which updates your computer after a
+kernel update.
+
+### Cron script
+
+Your system downloads the packages using this script.
+
+Adjust the script using your favorite editor:
+
+```
+vim src/autoupdate
+```
+
+Then as root:
+
+```
+cp src/autoupdate /etc/cron.daily
+chown root:root /etc/cron.daily/autoupdate
+chmod +x /etc/cron.daily/autoupdate
+```
+
+### rc.update
+
+Your system updates your installed packages using this script.
+
+Adjust the script using your favorite editor:
+
+```
+vim src/rc.update
+```
+
+Then as root:
+
+```
+cp src/rc.update /etc/rc.d/
+chown root:root /etc/rc.d/rc.update
+```
+
+Then add this to /etc/rc.d/rc.local:
+
+```
+if [ -x /etc/rc.d/rc.update ]; then
+  /etc/rc.d/rc.update
+fi
+```
+
+To enable installation on reboot:
+
+```
+chmod +x /etc/rc.d/rc.update
+```
+
+or to disable it again:
+
+```
+chmod -x /etc/rc.d/rc.update
+```
+
+### install-kernel
+
+This part depends on your system setup and will automatically update the kernel
+into your system.  You should modify it to suit your circumstance.
+
+The default script assumes you are using elilo and the kernel for your EFI is
+installed into /efi/EFI/Slackware/vmlinuz.
+
+Adjust the script to your system using your favorite editor or vim:
+
+```
+vim install-kernel
+```
+
+Then as root:
+
+```
+cp install-kernel /usr/local/sbin
+chown root:root /usr/local/sbin/install-kernel
+chmod +x /usr/local/sbin/install-kernel
+```
+
+## Source
+
+### Testing
+
+You can test the project by running the shell files under the 'test' folder.
+
+```
+sh src/test/*.sh
+```