Adding README to explain inapt and packages
authorGianni Gambetti <gianni@gambetti.ca>
Sat, 28 Feb 2015 02:04:12 +0000 (21:04 -0500)
committerGianni Gambetti <gianni@gambetti.ca>
Sat, 28 Feb 2015 02:04:12 +0000 (21:04 -0500)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..e4bc289
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+
+These are the CSC's package lists. They should be used to keep all of the machines up to date, and limit installation differences between them.
+
+### inapt primer
+
+`inapt` is a wrapper around the `apt-get` tool for managing packages. It is used to group machines and the services that we want to have installed on them.
+
+`inapt` takes a list of files, and builds up a package list for that machine. By default, it only activates the profile for the hostname of the machine, but accepts other profiles by having `--profile PROFILE` passed through the command line.
+
+### usage example
+
+```
+sudo inapt nodes.ia packages.ia # what you're going to do to update CSC machines
+
+```
+
+### inapt syntax examples
+
+See nodes.ia for setting up of profiles, and packages.ia for the use of profiles to select package lists.
+
+