From d4f5c2b5645b6f9dc5758e0f5aea02cff3671f14 Mon Sep 17 00:00:00 2001 From: Rafael Reggiani Manzo Date: Wed, 27 Apr 2016 16:56:47 -0300 Subject: [PATCH] Convert README to markdown --- README.md | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.rdoc | 133 ------------------------------------------------------------------------------------------------------------------------------------- 2 files changed, 132 insertions(+), 133 deletions(-) create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/README.md b/README.md new file mode 100644 index 0000000..a41246c --- /dev/null +++ b/README.md @@ -0,0 +1,132 @@ +## README - Prezento + +[![Code Climate](https://codeclimate.com/github/mezuro/prezento/badges/gpa.svg)](https://codeclimate.com/github/mezuro/prezento) [![Build Status](https://travis-ci.org/mezuro/prezento.svg?branch=master)](https://travis-ci.org/mezuro/prezento) [![Test Coverage](https://codeclimate.com/github/mezuro/prezento/badges/coverage.svg)](https://codeclimate.com/github/mezuro/prezento/coverage) + +Prezento is the web interface for Mezuro. + +Mezuro project aims provide a platform to compare projects and metric techniques, teach how to use metrics through configurations, analyze code, avoid technical debts, and disseminate code metrics usage and understanding. + +### Contributing + +Please, have a look the wiki pages about development workflow and code standards: + +* https://github.com/mezuro/mezuro/wiki/Development-workflow +* https://github.com/mezuro/mezuro/wiki/Standards + +### Development + + +* System dependencies (Ubuntu 14.04 package names) + * build-essential + * curl + * postgresql-server-dev-9.3 + +* Unpacked dependecies + * PhantomJS >= 1.9.2 (http://phantomjs.org/) + * *NOTE:* Just create sym links for that, for example: + + ```bash + cd /usr/local/share + wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 + tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2 + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs + ``` + +* Ruby version + + `2.3.0` + + You can easily install it through the Ruby Version Manager - RVM. Instructions on how to do it can be found at http://rvm.io + + *NOTE:* If you are using the gnome-shell, or any derivate like terminator, you have to mark on your profile the option to use a "login bash". + + +* Configuration + + `bundle install` + +* Database creation + + `rake db:create` + +* Database initialization (The seeds script will need the kalibro configurations service running) + + `rake db:setup` + +* Alternatively you can just run the setup script (Will also need the kalibro configurations service running) + + `bin/setup` + +* How to run the test suite + + `rake` + +* Services (job queues, cache servers, search engines, etc.) + + *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz) + You can find it at https://github.com/mezuro/kalibro_processor + By default Mezuro will expect it to be running on port 8082 at localhost. + In order to run it as expected, run on two different terminal instances: + + ```bash + RAILS_ENV=local rails s -p 8082 + RAILS_ENV=local rake jobs:work + ``` + + *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz) + You can find it at https://github.com/mezuro/kalibro_configurations + By default Mezuro will expect it to be running on port 8083 at localhost. + In order to run it as expected, run on two different terminal instances: rails s -p 8083. + +* Deployment instructions + + Deployment is made through Capistrano (https://github.com/capistrano/capistrano) + + `cap production deploy` + + In order to do this, you must have the password. + + Otherwise, you can also modify the deployment file at config/deploy.rb. + +### Install + +* First Deploy + + 1. Make sure that the deployment file config/deploy.rb is correctly configured to the installation server; + 2. Also, make sure that the installation server already has rvm installed; + 3. cap deploy:setup will install the ruby correct ruby version, the gemset and all the directories tree; + 4. cap deploy:migrations deploys the code and run all the migrations + +### License + +Copyright (c) 2013-2016 The Author developers. + +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 . + +### Authors + +Please see the humans.txt (at the `public` folder) file with the authors + +### Acknowledgments + +The authors have been supported by organizations: + +University of São Paulo (USP) +FLOSS Competence Center +http://ccsl.ime.usp.br + +Brazilian National Research Council (CNPQ) +http://www.cnpq.br/ diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 4ceb058..0000000 --- a/README.rdoc +++ /dev/null @@ -1,133 +0,0 @@ -== README - Prezento - -{}[https://codeclimate.com/github/mezuro/prezento] {Build Status}[https://travis-ci.org/mezuro/prezento] {}[https://codeclimate.com/github/mezuro/prezento] - -Prezento is the web interface for Mezuro. - -Mezuro project aims provide a platform to compare projects and metric techniques, teach how to use metrics through configurations, analyze code, avoid technical debts, and disseminate code metrics usage and understanding. - -=== Contributing - -Please, have a look the wiki pages about development workflow and code standards: - -* https://github.com/mezuro/mezuro/wiki/Development-workflow -* https://github.com/mezuro/mezuro/wiki/Standards - -=== Development - - -* System dependencies (Ubuntu 14.04 package names) - - * build-essential - - * curl - - * postgresql-server-dev-9.3 - -* Unpacked dependecies - - * PhantomJS >= 1.9.2 (http://phantomjs.org/) - - *NOTE:* Just create sym links for that, for example: - - cd /usr/local/share - wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 - tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2 - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs - -* Ruby version - - 2.3.0 - - You can easily install it through the Ruby Version Manager - RVM. Instructions on how to do it can be found at http://rvm.io - - *NOTE:* If you are using the gnome-shell, or any derivate like terminator, you have to mark on your profile the option to use a "login bash". - - -* Configuration - - bundle install - -* Database creation - - rake db:create - -* Database initialization (The seeds script will need the kalibro configurations service running) - - rake db:setup - -* Alternatively you can just run the setup script (Will also need the kalibro configurations service running) - - bin/setup - -* How to run the test suite - - rake - -* Services (job queues, cache servers, search engines, etc.) - - *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz) - You can find it at https://github.com/mezuro/kalibro_processor - By default Mezuro will expect it to be running on port 8082 at localhost. - In order to run it as expected, run on two different terminal instances: - - RAILS_ENV=local rails s -p 8082 - RAILS_ENV=local rake jobs:work - - *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz) - You can find it at https://github.com/mezuro/kalibro_configurations - By default Mezuro will expect it to be running on port 8083 at localhost. - In order to run it as expected, run on two different terminal instances: rails s -p 8083. - -* Deployment instructions - - Deployment is made through Capistrano (https://github.com/capistrano/capistrano) - - cap production deploy - - In order to do this, you must have the password. - - Otherwise, you can also modify the deployment file at config/deploy.rb. - -=== Install - -* First Deploy - - 1. Make sure that the deployment file config/deploy.rb is correctly configured to the installation server; - 2. Also, make sure that the installation server already has rvm installed; - 3. cap deploy:setup will install the ruby correct ruby version, the gemset and all the directories tree; - 4. cap deploy:migrations deploys the code and run all the migrations - -=== License - -Copyright (c) 2013-2016 The Author developers. - -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 . - -=== Authors - -Please see the humans.txt (at the `public` folder) file with the authors - -=== Acknowledgments - -The authors have been supported by organizations: - -University of São Paulo (USP) -FLOSS Competence Center -http://ccsl.ime.usp.br - -Brazilian National Research Council (CNPQ) -http://www.cnpq.br/ -- libgit2 0.21.2