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