diff --git a/.gitignore b/.gitignore index 38887bb..11edcb0 100644 --- a/.gitignore +++ b/.gitignore @@ -27,4 +27,6 @@ config/environments/test.rb +# Ignore local licensing and readme information +README.rdoc diff --git a/README.md b/README.md index eae0ba3..dbb1d0d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,48 @@ ## DMP Roadmap +DMP Roadmap is a Data Management Planning tool. It allows users to create data management plans for the projects using funder specific templates and institutional guidance. Once a plan has been completed it can be downloaded and inserted into your grant proposals. + +Management and development of the DMP Roadmap is jointly provided by the Digital Curation Centre (DCC), http://www.dcc.ac.uk/, and the University of California Curation Center (UC3), http://www.cdlib.org/services/uc3/ + +The tool has four main functions +1. To help create and maintain different versions of Data Management Plans; +2. To provide useful guidance on data management issues and how to meet research funders' requirements; +3. To export attractive and useful plans in a variety of formats; +4. To allow collaborative work when creating Data Management Plans. + #### Current Release v.0.1.0 #### Summary +#### Pre-requisites +DMPonline is a Ruby on Rails application and you will need to have: +1. Ruby >= 2.0.0p247 +2. Rails >= 4.0 +3. MySql >= 5.0 + +Further details on how to install Ruby on Rails applications are available from the Ruby on Rails site, http://rubyonrails.org + +You may also find the following resources handy: + +* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html +* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ + #### Installation -Clone the repository and build from the latest tag +Fork the repository and then clone it onto your server +> git clone https://github.com/[your organization]/roadmap.git +> #### Troubleshooting +#### Support +Issues should be reported here on Github https://github.com/DMPRoadmap/roadmap/issues +Please be advised though that we can only provide limited support for your local installations. + #### Become a contributor -Fork the repository. +Fork this repository and make your modifications in a new branch. Then create a pull request to our 'development' branch. We will reject any pull request made against the 'master' branch. Once your pull request has been submitted the team will review your request and accept it if appropriate. + +Join the email listserv at roadmap-l (at) listserv.ucop (dot) edu. #### License The DMP Roadmap project uses to the MIT License. diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 3ca4a88..0000000 --- a/README.rdoc +++ /dev/null @@ -1,43 +0,0 @@ -= DMPonline v4 - -DMPonline is the DCC's data management planning tool, available at https://dmponline.dcc.ac.uk - -Development of the DMPonline by the Digital Curation Centre has been funded by JISC. JISC inspires UK colleges and universities in the innovative use of digital technologies, helping to maintain the UK's position as a global leader in education. www.jisc.ac.uk - -This is just the application code, the accompanying question data available at https://dmponline.dcc.ac.uk is not included. - -The tool has four main functions -1. To help create and maintain different versions of Data Management Plans; -2. To provide useful guidance on data management issues and how to meet research funders' requirements; -3. To export attractive and useful plans in a variety of formats; -4. To allow collaborative work when creating Data Management Plans. - -== Documentation & Support - -* You can contact us by email, dmponline@dcc.ac.uk, but we can only provide limited support for your installation - -== Bugs & Feature Requests - -* Bug Reports & Feature Requests: https://github.com/DigitalCurationCentre/DMPonline_v4/issues - -== Prerequisites - -DMPonline is a Ruby on Rails application and you will need to have Ruby 2.0.0p247 or greater installed on your server and a MySQL server v5.0 or greater. - -Further details on how to install Ruby on Rails applications are available from the Ruby on Rails site, http://rubyonrails.org - -You may also find the following resources handy: - -* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html -* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ - - -== Copyright - -Copyright (c) 2013 Digital Curation Centre, University of Edinburgh. - -This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero 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 Affero General Public License for more details. - -You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses.