From ad1d6a4a7c0939b7c27869563d74809288de2b97 Mon Sep 17 00:00:00 2001 From: rautenberg Date: Tue, 25 Feb 2014 10:29:29 +0100 Subject: add .yardopts, mv README.markdown to README.md --- .yardopts | 4 ++++ README.markdown | 38 -------------------------------------- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 42 insertions(+), 38 deletions(-) create mode 100644 .yardopts delete mode 100644 README.markdown create mode 100644 README.md diff --git a/.yardopts b/.yardopts new file mode 100644 index 0000000..cef1332 --- /dev/null +++ b/.yardopts @@ -0,0 +1,4 @@ +--readme README +--title 'Thin Ruby wrapper for the OpenTox REST API' +--charset utf-8 +yardoc lib/*.rb - README ChangeLog VERSION LICENSE diff --git a/README.markdown b/README.markdown deleted file mode 100644 index 70760ae..0000000 --- a/README.markdown +++ /dev/null @@ -1,38 +0,0 @@ -opentox-client -==================== - -Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. - -Libraries: - -* {OpenTox::Algorithm} Wrapper for OpenTox Algorithms -* {OpenTox::Authorization} Authorization and Authentication -* {OpenTox::Compound} Compound Library -* {OpenTox::Dataset} Dataset Library -* {OpenTox::Error} extends Exception class according the OpenTox API -* {OpenTox::Model} Model Library -* {OpenTox} OpenTox Library - general definition of OpenTox objects -* {OTLogger} OpenTox Logger Extensions -* {OpenTox::Policies} parse and serialize XML for the openSSO A&A server -* {OpenTox::RestClientWrapper} wrapper for the RestClient gem -* {OpenTox::Task} Task Library - - -Dependencies ------------- - - libraptor1-dev - -Installation ------------- - - gem install opentox-client - -Documentation -------------- -* [API documentation](http://rdoc.info/gems/opentox-client) -* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) - -Copyright ---------- -Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. diff --git a/README.md b/README.md new file mode 100644 index 0000000..70760ae --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +opentox-client +==================== + +Thin Ruby wrapper for the [OpenTox](http://www.opentox.org) REST API. + +Libraries: + +* {OpenTox::Algorithm} Wrapper for OpenTox Algorithms +* {OpenTox::Authorization} Authorization and Authentication +* {OpenTox::Compound} Compound Library +* {OpenTox::Dataset} Dataset Library +* {OpenTox::Error} extends Exception class according the OpenTox API +* {OpenTox::Model} Model Library +* {OpenTox} OpenTox Library - general definition of OpenTox objects +* {OTLogger} OpenTox Logger Extensions +* {OpenTox::Policies} parse and serialize XML for the openSSO A&A server +* {OpenTox::RestClientWrapper} wrapper for the RestClient gem +* {OpenTox::Task} Task Library + + +Dependencies +------------ + + libraptor1-dev + +Installation +------------ + + gem install opentox-client + +Documentation +------------- +* [API documentation](http://rdoc.info/gems/opentox-client) +* [RubyDoc.info Code documentation](http://rubydoc.info/github/opentox/opentox-client/development/frames) + +Copyright +--------- +Copyright (c) 2009-2014 Christoph Helma, Martin Guetlein, Micha Rautenberg, Andreas Maunz, David Vorgrimmler, Denis Gebele. See LICENSE for details. -- cgit v1.2.3