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