Add initial version of README

1 files changed, 55 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..9271d25
--- /dev/null
+++ b/README
@@ -0,0 +1,55 @@
+README for jenkinstool
+======================
+
+jenkinstool manages jobs in a Jenkins instance. It creates, updates,
+and removes jobs for my projects in a systematic manner.
+
+I have a bunch of personal projects, and I like to have continuous
+integration for them, especially since many of my projects depend on
+each other. For example, the `cliapp` command line application framework
+for Python is used by every other project of mine that has a command
+line interface of any kind. When I make any changes to `cliapp`, I want
+to catch any problems they may cause as early as possible.
+
+I create Debian packages of most of my projects, and I want that to be
+done as automatically as possible. The Debian packaging toolset is 
+powerful, but it takes a bit of effort to set everything up just right,
+especially since I need to build my packages in multiple environments:
+32-bit and 64-bit Intel architectures, and for at least two and possibly 
+three releases of Debian. But some packages should be built in only
+some environments, so it's not all identical, either.
+
+Thus I use Jenkins to drive the package building process as well.
+Automating this removes much manual hassle from my release process.
+
+As a result, I have a large number of very similar jobs in Jenkins,
+and I refuse to even try to manage them manually. Instead, I wrote
+a tool to do that for me.
+
+Note that jenkinstool is in its early days of development.
+
+Author
+------
+
+* Author: Lars Wirzenius
+* Home page: <http://liw.fi/>
+
+
+Legalese
+--------
+
+Copyright 2012  Lars Wirzenius
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+