The README was not specific enough about the current state of our Ruby support. This commit lays out our current status as discussed in issue #7506 and in greater detail on the internal mailing list around April 8, 2011 under the subject "Statler Ruby Versions Support."
This commit also consolidates two redundant README files into one. Paired-With: Matt Robinson <m...@puppetlabs.com> Signed-off-by: nfagerlund <nick.fagerl...@gmail.com> --- README | 31 ------------------------------- README.rst => README.md | 27 +++++++++++++++++---------- 2 files changed, 17 insertions(+), 41 deletions(-) delete mode 100644 README rename README.rst => README.md (63%) diff --git a/README b/README deleted file mode 100644 index d6b7d66..0000000 --- a/README +++ /dev/null @@ -1,31 +0,0 @@ -Documentation (and detailed install instructions) can be found -online at http://docs.puppetlabs.com/. - -Additional documentation can also be found at the Puppet Wiki: - -http://projects.puppetlabs.com/projects/puppet/wiki/ - -Generally, you need the following things installed: - -* Ruby >= 1.8.1 (earlier releases might work but probably not) - -* The Ruby OpenSSL library. For some reason, this often isn't included - in the main ruby distributions. You can test for it by running - 'ruby -ropenssl -e "puts :yep"'. If that errors out, you're missing the - library. - - If your distribution doesn't come with the necessary library (e.g., on Debian - and Ubuntu you need to install libopenssl-ruby), then you'll probably have to - compile Ruby yourself, since it's part of the standard library and not - available separately. You could probably just compile and install that one - library, though. - -* The Ruby XMLRPC client and server libraries. For some reason, this often - isn't included in the main ruby distributions. You can test for it by - running 'ruby -rxmlrpc/client -e "puts :yep"'. If that errors out, you're missing - the library. - -* Facter => 1.5.1 - You can get this from < http://puppetlabs.com/projects/facter > - -$Id$ diff --git a/README.rst b/README.md similarity index 63% rename from README.rst rename to README.md index 63452ef..75678d1 100644 --- a/README.rst +++ b/README.md @@ -5,17 +5,18 @@ Puppet, an automated administrative engine for your Linux and Unix systems, perf administrative tasks (such as adding users, installing packages, and updating server configurations) based on a centralized specification. -Documentation (and detailed install instructions) can be found online at the -`Puppet Documentation`_ site. - -Additional documentation can also be found at the `Puppet Wiki`_. +Documentation (and detailed installation instructions) can be found online at the +[Puppet Docs site](http://docs.puppetlabs.com). Installation ------------ Generally, you need the following things installed: -* Ruby >= 1.8.1 (earlier releases might work but probably not) +* A supported Ruby version. Ruby 1.8.5 and 1.8.7 are fully supported; Ruby 1.8.1 + is supported on a best-effort basis for agent use only. Other versions of Ruby + are used at your own risk, and Ruby 1.8.6 is not recommended for compatibility + reasons. * The Ruby OpenSSL library. For some reason, this often isn't included in the main ruby distributions. You can test for it by running @@ -33,9 +34,15 @@ Generally, you need the following things installed: running 'ruby -rxmlrpc/client -e "puts :yep"'. If that errors out, you're missing the library. -* Facter => 1.5.1 - You can get this from your package management system or the `Facter site`_ +* Facter => 1.5.1 (available via your package manager or from the [Facter site](http://puppetlabs.com/projects/facter). + +License +------- + +See LICENSE file. + +Support +------- + +Please log tickets and issues at our [Projects site](http://projects.puppetlabs.com) -.. _Puppet Documentation: http://docs.puppetlabs.com -.. _Puppet Wiki: http://projects.puppetlabs.com/projects/puppet/wiki/ -.. _Facter site: http://puppetlabs.com/projects/facter -- 1.7.3.3 -- You received this message because you are subscribed to the Google Groups "Puppet Developers" group. To post to this group, send email to puppet-dev@googlegroups.com. To unsubscribe from this group, send email to puppet-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/puppet-dev?hl=en.
