Download as
Browse Code »

Commit d4f5c2b5645b6f9dc5758e0f5aea02cff3671f14

Authored by Rafael Reggiani Manzo
Committed by Diego Araújo
1 parent 0cccad8c
Exists in colab and in 2 other branches master, stable

Convert README to markdown 

This is an easier to maintain format.
Showing 2 changed files with 132 additions and 133 deletions   Show diff stats
README.md 0 → 100644
  Diff comments   View file @d4f5c2b
... ... @@ -0,0 +1,132 @@
  1 +## README - Prezento
  2 +
  3 +[![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)
  4 +
  5 +Prezento is the web interface for Mezuro.
  6 +
  7 +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.
  8 +
  9 +### Contributing
  10 +
  11 +Please, have a look the wiki pages about development workflow and code standards:
  12 +
  13 +* https://github.com/mezuro/mezuro/wiki/Development-workflow
  14 +* https://github.com/mezuro/mezuro/wiki/Standards
  15 +
  16 +### Development
  17 +
  18 +
  19 +* System dependencies (Ubuntu 14.04 package names)
  20 + * build-essential
  21 + * curl
  22 + * postgresql-server-dev-9.3
  23 +
  24 +* Unpacked dependecies
  25 + * PhantomJS >= 1.9.2 (http://phantomjs.org/)
  26 + * *NOTE:* Just create sym links for that, for example:
  27 +
  28 + ```bash
  29 + cd /usr/local/share
  30 + wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2
  31 + tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2
  32 + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs
  33 + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs
  34 + sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs
  35 + ```
  36 +
  37 +* Ruby version
  38 +
  39 + `2.3.0`
  40 +
  41 + You can easily install it through the Ruby Version Manager - RVM. Instructions on how to do it can be found at http://rvm.io
  42 +
  43 + *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".
  44 +
  45 +
  46 +* Configuration
  47 +
  48 + `bundle install`
  49 +
  50 +* Database creation
  51 +
  52 + `rake db:create`
  53 +
  54 +* Database initialization (The seeds script will need the kalibro configurations service running)
  55 +
  56 + `rake db:setup`
  57 +
  58 +* Alternatively you can just run the setup script (Will also need the kalibro configurations service running)
  59 +
  60 + `bin/setup`
  61 +
  62 +* How to run the test suite
  63 +
  64 + `rake`
  65 +
  66 +* Services (job queues, cache servers, search engines, etc.)
  67 +
  68 + *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz)
  69 + You can find it at https://github.com/mezuro/kalibro_processor
  70 + By default Mezuro will expect it to be running on port 8082 at localhost.
  71 + In order to run it as expected, run on two different terminal instances:
  72 +
  73 + ```bash
  74 + RAILS_ENV=local rails s -p 8082
  75 + RAILS_ENV=local rake jobs:work
  76 + ```
  77 +
  78 + *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz)
  79 + You can find it at https://github.com/mezuro/kalibro_configurations
  80 + By default Mezuro will expect it to be running on port 8083 at localhost.
  81 + In order to run it as expected, run on two different terminal instances: <tt>rails s -p 8083</tt>.
  82 +
  83 +* Deployment instructions
  84 +
  85 + Deployment is made through Capistrano (https://github.com/capistrano/capistrano)
  86 +
  87 + `cap production deploy`
  88 +
  89 + In order to do this, you must have the password.
  90 +
  91 + Otherwise, you can also modify the deployment file at <tt>config/deploy.rb</tt>.
  92 +
  93 +### Install
  94 +
  95 +* First Deploy
  96 +
  97 + 1. Make sure that the deployment file <tt>config/deploy.rb</tt> is correctly configured to the installation server;
  98 + 2. Also, make sure that the installation server already has rvm installed;
  99 + 3. <tt>cap deploy:setup</tt> will install the ruby correct ruby version, the gemset and all the directories tree;
  100 + 4. <tt>cap deploy:migrations</tt> deploys the code and run all the migrations
  101 +
  102 +### License
  103 +
  104 +Copyright (c) 2013-2016 The Author developers.
  105 +
  106 +This program is free software: you can redistribute it and/or modify
  107 +it under the terms of the GNU Affero General Public License as published by
  108 +the Free Software Foundation, either version 3 of the License, or
  109 +(at your option) any later version.
  110 +
  111 +This program is distributed in the hope that it will be useful,
  112 +but WITHOUT ANY WARRANTY; without even the implied warranty of
  113 +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  114 +GNU Affero General Public License for more details.
  115 +
  116 +You should have received a copy of the GNU Affero General Public License
  117 +along with this program. If not, see <http://www.gnu.org/licenses/>.
  118 +
  119 +### Authors
  120 +
  121 +Please see the humans.txt (at the `public` folder) file with the authors
  122 +
  123 +### Acknowledgments
  124 +
  125 +The authors have been supported by organizations:
  126 +
  127 +University of São Paulo (USP)
  128 +FLOSS Competence Center
  129 +http://ccsl.ime.usp.br
  130 +
  131 +Brazilian National Research Council (CNPQ)
  132 +http://www.cnpq.br/
... ...
README.rdoc
View file @0cccad8
... ... @@ -1,133 +0,0 @@
1   -== README - Prezento
2   -
3   -{<img src="https://codeclimate.com/github/mezuro/prezento.png" />}[https://codeclimate.com/github/mezuro/prezento] {<img src="https://travis-ci.org/mezuro/prezento.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mezuro/prezento] {<img src="https://codeclimate.com/github/mezuro/prezento/badges/coverage.svg" />}[https://codeclimate.com/github/mezuro/prezento]
4   -
5   -Prezento is the web interface for Mezuro.
6   -
7   -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.
8   -
9   -=== Contributing
10   -
11   -Please, have a look the wiki pages about development workflow and code standards:
12   -
13   -* https://github.com/mezuro/mezuro/wiki/Development-workflow
14   -* https://github.com/mezuro/mezuro/wiki/Standards
15   -
16   -=== Development
17   -
18   -
19   -* System dependencies (Ubuntu 14.04 package names)
20   -
21   - * build-essential
22   -
23   - * curl
24   -
25   - * postgresql-server-dev-9.3
26   -
27   -* Unpacked dependecies
28   -
29   - * PhantomJS >= 1.9.2 (http://phantomjs.org/)
30   -
31   - *NOTE:* Just create sym links for that, for example:
32   -
33   - cd /usr/local/share
34   - wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2
35   - tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2
36   - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs
37   - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs
38   - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs
39   -
40   -* Ruby version
41   -
42   - 2.3.0
43   -
44   - You can easily install it through the Ruby Version Manager - RVM. Instructions on how to do it can be found at http://rvm.io
45   -
46   - *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".
47   -
48   -
49   -* Configuration
50   -
51   - bundle install
52   -
53   -* Database creation
54   -
55   - rake db:create
56   -
57   -* Database initialization (The seeds script will need the kalibro configurations service running)
58   -
59   - rake db:setup
60   -
61   -* Alternatively you can just run the setup script (Will also need the kalibro configurations service running)
62   -
63   - bin/setup
64   -
65   -* How to run the test suite
66   -
67   - rake
68   -
69   -* Services (job queues, cache servers, search engines, etc.)
70   -
71   - *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz)
72   - You can find it at https://github.com/mezuro/kalibro_processor
73   - By default Mezuro will expect it to be running on port 8082 at localhost.
74   - In order to run it as expected, run on two different terminal instances:
75   -
76   - RAILS_ENV=local rails s -p 8082
77   - RAILS_ENV=local rake jobs:work
78   -
79   - *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz)
80   - You can find it at https://github.com/mezuro/kalibro_configurations
81   - By default Mezuro will expect it to be running on port 8083 at localhost.
82   - In order to run it as expected, run on two different terminal instances: <tt>rails s -p 8083</tt>.
83   -
84   -* Deployment instructions
85   -
86   - Deployment is made through Capistrano (https://github.com/capistrano/capistrano)
87   -
88   - cap production deploy
89   -
90   - In order to do this, you must have the password.
91   -
92   - Otherwise, you can also modify the deployment file at <tt>config/deploy.rb</tt>.
93   -
94   -=== Install
95   -
96   -* First Deploy
97   -
98   - 1. Make sure that the deployment file <tt>config/deploy.rb</tt> is correctly configured to the installation server;
99   - 2. Also, make sure that the installation server already has rvm installed;
100   - 3. <tt>cap deploy:setup</tt> will install the ruby correct ruby version, the gemset and all the directories tree;
101   - 4. <tt>cap deploy:migrations</tt> deploys the code and run all the migrations
102   -
103   -=== License
104   -
105   -Copyright (c) 2013-2016 The Author developers.
106   -
107   -This program is free software: you can redistribute it and/or modify
108   -it under the terms of the GNU Affero General Public License as published by
109   -the Free Software Foundation, either version 3 of the License, or
110   -(at your option) any later version.
111   -
112   -This program is distributed in the hope that it will be useful,
113   -but WITHOUT ANY WARRANTY; without even the implied warranty of
114   -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
115   -GNU Affero General Public License for more details.
116   -
117   -You should have received a copy of the GNU Affero General Public License
118   -along with this program. If not, see <http://www.gnu.org/licenses/>.
119   -
120   -=== Authors
121   -
122   -Please see the humans.txt (at the `public` folder) file with the authors
123   -
124   -=== Acknowledgments
125   -
126   -The authors have been supported by organizations:
127   -
128   -University of São Paulo (USP)
129   -FLOSS Competence Center
130   -http://ccsl.ime.usp.br
131   -
132   -Brazilian National Research Council (CNPQ)
133   -http://www.cnpq.br/