mango 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/LICENSE +20 -0
  2. data/README.mdown +121 -0
  3. metadata +71 -0
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2010 Ryan Sobol
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,121 @@
1
+ ![Exotic Fruit](http://www.bctree.com/images/photos/sourced-mango.jpg)
2
+
3
+ Image courtesy of [B.C. Tree Fruits LTD.](http://www.bctree.com/products/sourced/mango.php)
4
+
5
+ Mango release 0.1.0 (June 15, 2010)
6
+ ===================================
7
+
8
+ Copyright (c) 2010 Ryan Sobol. Licensed under the MIT license. Please see the {file:LICENSE} for more information.
9
+
10
+ **Source Code**: [http://github.com/ryansobol/mango](http://github.com/ryansobol/mango)
11
+ **Bug Tracker**: [http://github.com/ryansobol/mango/issues](http://github.com/ryansobol/mango/issues)
12
+ **Wiki**: [http://wiki.github.com/ryansobol/mango](http://wiki.github.com/ryansobol/mango)
13
+
14
+ WHAT'S NEW?
15
+ -----------
16
+
17
+ * Dynamically route HTTP requests to Haml content pages
18
+ * Route unknown pages to a customizable 404 page
19
+ * Wrap content pages within customizable Haml templates and layouts
20
+ * Publish to any Rack-based application server (e.g. Phusion Passenger, thin, mongrel, webrick, etc.)
21
+
22
+ Please see {file:doc/HISTORY.mdown} for the historical overview of the project.
23
+
24
+ SYNOPSIS
25
+ --------
26
+
27
+ **Mango is a dynamic blog engine for Ruby hackers who believe in minimalism.**
28
+
29
+ Mango let's you use publish to the web using the tools you're already familiar with -- the file system and your trusty text editor. With Mango, there is:
30
+
31
+ * No clunky administrator interface for managing content
32
+ * No unchangeable database requirements -- no database period!
33
+ * No know exploits ;)
34
+
35
+ FEATURES
36
+ --------
37
+
38
+ * Dynamically route HTTP requests to Haml content pages
39
+ * Route unknown pages to a customizable 404 page
40
+ * Wrap content pages within customizable Haml templates and layout
41
+ * Publish to any Rack-based application server (e.g. Phusion Passenger, thin, mongrel, webrick, etc.)
42
+
43
+ REQUIREMENTS
44
+ ------------
45
+
46
+ **Required dependencies**
47
+
48
+ * Ruby 1.9.1
49
+ * Rack 1.2.1
50
+ * Sinatra 1.0
51
+ * Haml 3.0.12
52
+
53
+ **Optional development dependencies**
54
+
55
+ * Rake 0.8.7 (bundled with Ruby 1.9.1)
56
+ * Rack::Test 0.5.4
57
+ * RSpec 1.3.0
58
+ * YARD 0.5.5
59
+ * BlueCloth 2.0.7
60
+
61
+ INSTALLING
62
+ ----------
63
+
64
+ $ git clone git@github.com:ryansobol/mango.git
65
+ $ cd mango
66
+ $ bundle install
67
+
68
+ USAGE
69
+ -----
70
+
71
+ ### A sample blog structure
72
+
73
+ |-- content
74
+ | |-- about
75
+ | | |-- index.haml
76
+ | | `-- us.haml
77
+ | `-- index.haml
78
+ `-- themes
79
+ `-- default
80
+ |-- public
81
+ `-- views
82
+ |-- 404.haml
83
+ |-- layout.haml
84
+ `-- page.haml
85
+
86
+ ### Starting a development server
87
+
88
+ $ rackup
89
+
90
+ MOTIVATION
91
+ ----------
92
+
93
+ Scratching my own itch. Inspired by [Nesta](http://effectif.com/nesta) and [Jekyll](http://jekyllrb.com/).
94
+
95
+ REPORTING ISSUES
96
+ ----------------
97
+
98
+ Is Mango not behaving like you expect it should? Please forgive me! Would you take a moment to shed light on my negligence over at the [Issue Tracker](http://github.com/ryansobol/mango/issues)? Here's a **Pro Tip** -- you can read through existing issues and vote for which issues you'd like to see resolved first!
99
+
100
+ Thank you for taking the time to help improve Mango.
101
+
102
+ CONTRIBUTING
103
+ ------------
104
+
105
+ Is Mango not behaving like you need? Open-source to the rescue! There is a plethora of documentation to bring a Rubyist of any level up to speed. The API documentation is generated, once the dependencies are met (please see the REQUIREMENTS section), by issuing the follow command:
106
+
107
+ $ rake yard
108
+
109
+ Patches are always welcome and appreciated! The process is straight-forward for contributing your work back to the source:
110
+
111
+ * Fork the project -- may I suggest [Github](http://www.github.com)?
112
+ * Make your feature addition or bug fix **with specifications**. It's important that I don't break your hard work in a future version unintentionally.
113
+ * Please do not casually alter files in the project root. (e.g. LICENSE, Rakefile, README.mdown, VERSION, etc.)
114
+ * Commit your changes and publish the change-set.
115
+ * Send me a pull request. Remember, all specs must pass!
116
+
117
+ Before making your change, take a moment to get a feel for the style of coding, specifications, and in-line documentation.
118
+
119
+ Please see {file:doc/ROAD-MAP.mdown} to learn how to flow with the project. In the near future, I plan on pushing this content directly into the [Issue Tracker](http://github.com/ryansobol/mango/issues).
120
+
121
+ Again, thank you for taking the time to help improve Mango.
metadata ADDED
@@ -0,0 +1,71 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mango
3
+ version: !ruby/object:Gem::Version
4
+ hash: 27
5
+ prerelease: false
6
+ segments:
7
+ - 0
8
+ - 1
9
+ - 0
10
+ version: 0.1.0
11
+ platform: ruby
12
+ authors:
13
+ - Ryan Sobol
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2010-06-15 00:00:00 -05:00
19
+ default_executable:
20
+ dependencies: []
21
+
22
+ description: Mango let's you use publish to the web using the tools you're already familiar with -- the file system and your trusty text editor.
23
+ email:
24
+ - contact@ryansobol.com
25
+ executables: []
26
+
27
+ extensions: []
28
+
29
+ extra_rdoc_files: []
30
+
31
+ files:
32
+ - LICENSE
33
+ - README.mdown
34
+ has_rdoc: true
35
+ homepage: http://github.com/ryansobol/mango
36
+ licenses: []
37
+
38
+ post_install_message:
39
+ rdoc_options: []
40
+
41
+ require_paths:
42
+ - lib
43
+ required_ruby_version: !ruby/object:Gem::Requirement
44
+ none: false
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ hash: 3
49
+ segments:
50
+ - 0
51
+ version: "0"
52
+ required_rubygems_version: !ruby/object:Gem::Requirement
53
+ none: false
54
+ requirements:
55
+ - - ">="
56
+ - !ruby/object:Gem::Version
57
+ hash: 21
58
+ segments:
59
+ - 1
60
+ - 3
61
+ - 7
62
+ version: 1.3.7
63
+ requirements: []
64
+
65
+ rubyforge_project: mango
66
+ rubygems_version: 1.3.7
67
+ signing_key:
68
+ specification_version: 3
69
+ summary: Mango is a dynamic blog engine for Ruby hackers who believe in minimalism.
70
+ test_files: []
71
+