blob: 028f842183e7ffbc57fcf7bdb7e9f7d72a627b70 [file] [log] [blame]
martin f. krafft46c06522013-07-03 20:03:22 +02001=============================================================
2 reclass recursive external node classification
3=============================================================
4reclass is © 20072013 martin f. krafft <madduck@madduck.net>
5and available under the terms of the Artistic Licence 2.0
6'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
7
8Installation
9~~~~~~~~~~~~
10If you just want to run reclass from source, e.g. because you are going to be
11making and testing changes, install it in "development mode":
12
13 python setup.py develop
14
martin f. krafft30943272013-07-04 08:32:00 +020015Now the reclass script, as well as the adapters, will be available in
16/usr/local/bin, and you can also invoke them directly from the source tree.
17
martin f. krafft46c06522013-07-03 20:03:22 +020018To uninstall:
19
20 python setup.py develop --uninstall
21
22Discussing reclass
23~~~~~~~~~~~~~~~~~~
24If you want to talk about reclass, the best way right now is to use the
25salt-users mailing list (please put 'reclass' into the subject), or to find me
26on IRC, either 'madduck' in the #salt/freenode channel, or in #reclass/oftc.
27
28Contributing to reclass
29~~~~~~~~~~~~~~~~~~~~~~~
30Conttributions to reclass are very welcome. Since I prefer to keep a somewhat
31clean history, I will not just merge pull request.
32
33You can submit pull requests, of course, and I'll rebase them onto HEAD before
34merging. Or send your patches using git-format-patch and git-send-e-mail to
35reclass@pobox.madduck.net.
36
37I have added rudimentary unit tests, and it would be nice if you could submit
38your changes with appropriate changes to the tests. To run tests, invoke
39./run_tests.py in the top-level checkout directory.
40
41If you have larger ideas, I'll be looking forward to discuss them with you.
42
martin f. krafft30943272013-07-04 08:32:00 +020043 -- martin f. krafft <madduck@madduck.net> Thu, 04 Jul 2013 22:20:20 +0200