Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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