Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 87 lines (60 sloc) 4.547 kB
efbe1c3 @nesquena [padrino] Remove all detailed information from top README. Leave in s…
nesquena authored
1 = Padrino
469974f @nesquena Initial commit after merging padrino subgems into single repo
nesquena authored
2
b6bb171 @DAddYE Nicer layout.
DAddYE authored
3 Padrino is the godfather of Sinatra. Follow us on
4 {www.padrinorb.com}[http://padrinorb.com] and on twitter
e375507 @DAddYE Added a couple of links in our readme.
DAddYE authored
5 {@padrinorb}[http://twitter.com/padrinorb]
6
ec8b5f5 @nesquena Move CI status into Padrino section
nesquena authored
7 {<img src="http://travis-ci.org/padrino/padrino-framework.png" />}[http://travis-ci.org/padrino/padrino-framework]
8
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
9 == Preface
10
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
11 Padrino is a ruby framework built upon the excellent {Sinatra Microframework}[http://www.sinatrarb.com].
12 Sinatra is a DSL for creating simple web applications in Ruby with speed and minimal effort.
13 This framework tries hard to make it as fun and easy as possible to code much more advanced web applications by
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Of…
nesquena authored
14 building upon the Sinatra philosophies and foundation.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
15
16 == Introduction
17
408aefd @nesquena Cleaning up preface and introduction in the README
nesquena authored
18 Many people love Sinatra's simplicity and lightweight but often quickly come to miss a great deal
19 of functionality provided by other web frameworks such as Rails when building non-trivial applications.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
20
f7b13c6 [padrino-core] Improved Doc
Davide D'Agostino authored
21 Our goal with this framework is to match the essence of Sinatra and at the same time create a standard library
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
22 of tools, helpers and components that will make Sinatra suitable for more complex applications.
23
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Of…
nesquena authored
24 Here is a brief overview of functionality provided by the Padrino framework:
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
25
eaad183 @nesquena [padrino-core] Fixes features table in readme
nesquena authored
26 Agnostic:: Full support for many popular testing, templating, mocking, and data storage choices.
27 Generators:: Create Padrino applications, models, controllers i.e: padrino-gen project.
28 Mountable:: Unlike other ruby frameworks, principally designed for mounting multiple apps.
29 Routing:: Full url named routes, named params, respond_to support, before/after filter support.
30 Tag Helpers:: View helpers such as: tag, content_tag, input_tag.
31 Asset Helpers:: View helpers such as: link_to, image_tag, javascript_include_tag.
32 Form Helpers:: Builder support such as: form_tag, form_for, field_set_tag, text_field.
3984c59 @nesquena Fix relative_time_ago => time_ago_in_words in docs
nesquena authored
33 Text Helpers:: Useful formatting like: time_ago_in_words, js_escape_html, sanitize_html.
eaad183 @nesquena [padrino-core] Fixes features table in readme
nesquena authored
34 Mailer:: Fast and simple delivery support for sending emails (akin to ActionMailer).
35 Admin:: Builtin Admin interface (like Django)
36 Logging:: Provide a unified logger that can interact with your ORM or any library.
cbdc0e8 @DAddYE Whitespace fix!
DAddYE authored
37 Reloading:: Automatically reloads server code during development.
c629aac @nesquena [doc] Standardize quote chars in READMEs
nesquena authored
38 Localization:: Full support of I18n language localization and can auto-set user's locale.
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
39
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
40 Keep in mind, the user will be able to pull in these components
d734cce @rwilcox fixed spelling error in README
rwilcox authored
41 {separately into existing Sinatra applications}[http://www.padrinorb.com/guides/standalone-usage-in-sinatra]
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
42 or use them altogether for a comprehensive upgrade to Sinatra (a full-stack Padrino application).
43
44 == Installation
45
46 To install the padrino framework, simply grab the latest version from gemcutter:
47
df4d1ea @nesquena [README] Remove sudo from installation guide
nesquena authored
48 $ gem install padrino
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
49
0b6a601 @nesquena Migrated existing README's from sinatra_more over to padrino gems
nesquena authored
50 This will install the necessary padrino gems to get you started.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
51 Now you are ready to use this gem to enhance your sinatra projects or to create new Padrino applications.
52
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
53 For a more detailed look at Padrino installation,
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
54 check out the {Installation Guide}[http://www.padrinorb.com/guides/installation].
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Of…
nesquena authored
55
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
56 == Usage
57
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
58 Padrino is a framework which builds on the existing functionality and Sinatra and provides a variety of
c856f2e @nesquena [padrino] Truncating and fixing up additional parts of the README. Of…
nesquena authored
59 additional tools and helpers to build upon that foundation. This README and Padrino documentation in general will focus
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
60 on the enhancements to the core Sinatra functionality. To use Padrino, one should be familiar with the basic
61 usage of Sinatra itself.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
62
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
63 You can also check out the
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
64 {Understanding Sinatra}[http://www.padrinorb.com/guides/underlying-sinatra-overview] guide
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
65 to learn more about these fundamentals.
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
66
e632ee3 @nesquena [padrino] Truncating README's to shorten them and link to guides.
nesquena authored
67 For information on how to use a specific gem in isolation within an existing Sinatra project, checkout the guide for
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
68 {Using Padrino in Sinatra}[http://www.padrinorb.com/guides/standalone-usage-in-sinatra].
886c46a @nesquena Added skeleton for explaining padrino enhancements in parent README
nesquena authored
69
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
70 == Getting Started
71
72 Once a developer understands Sinatra, Padrino is quite easy to get comfortable with since Padrino is simply a superset
9f8ac99 @DAddYE Stripped white spaces.
DAddYE authored
73 of existing Sinatra Functionality!
efbe1c3 @nesquena [padrino] Remove all detailed information from top README. Leave in s…
nesquena authored
74
75 Best way to get started with building Padrino applications is to read following resources:
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
76
fc6be35 @DAddYE Updated links.
DAddYE authored
77 * {Padrino Guides}[http://www.padrinorb.com/guides] - Guides outlining the major functionality within Padrino.
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
78 * {Blog Tutorial}[http://www.padrinorb.com/guides/blog-tutorial] - Step-by-step guide to building a blog application with Padrino.
fc6be35 @DAddYE Updated links.
DAddYE authored
79 * {Padrino RDoc}[http://www.padrinorb.com/api/index.html] - Rdoc documentation for the Padrino framework.
493e0ea @DAddYE Updated our wiki links.
DAddYE authored
80 * {Quick Overview}[http://www.padrinorb.com/guides/basic-projects] - Outlines basic generation commands.
83d761e @nesquena [padrino] More additions / corrections on README
nesquena authored
81
f05e076 @nesquena [padrino] Adds additional resource links to README
nesquena authored
82 The individual Padrino sub-gems also contain README's which outlines their functionality.
7301590 [ALL] Adapted test to new changes.
Davide D'Agostino authored
83
84 == Copyright
93c87d2 @nesquena Added section in README about generators (padrino-core, padrino-gen)
nesquena authored
85
c629aac @nesquena [doc] Standardize quote chars in READMEs
nesquena authored
86 Copyright &copy; 2011 Padrino. See LICENSE for details.
Something went wrong with that request. Please try again.