deac/middleman
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #897 from middleman/readme-license-contributing

Browse source 
Readme / License / Contributing
This commit is contained in:
Thomas Reynolds 2013-05-18 13:25:13 -07:00
parent 15cfbd3b51 f20101ac32
commit 633e14f266
5 changed files with 89 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,44 @@
# Contributing
In the spirit of [free software][free-sw], **everyone** is encouraged to help
improve this project.
[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
Here are some ways *you* can contribute:
* by using alpha, beta, and prerelease versions
* by reporting bugs
* by suggesting new features
* by writing or editing documentation
* by writing specifications
* by writing code (**no patch is too small**: fix typos, add comments, clean up
inconsistent whitespace)
* by refactoring code
* by closing [issues][]
* by reviewing patches
[issues]: https://github.com/middleman/middleman/issues
## Submitting an Issue
We use the [GitHub issue tracker][issues] to track bugs and features. Before
submitting a bug report or feature request, check to make sure it hasn't
already been submitted. When submitting a bug report, please include a [Gist][]
that includes a stack trace and any details that may be necessary to reproduce
the bug, including your gem version, Ruby version, and operating system.
Ideally, a bug report should include a pull request with failing specs.
[gist]: https://gist.github.com/
## Submitting a Pull Request
1. [Fork the repository.][fork]
2. [Create a topic branch.][branch]
3. Add specs for your unimplemented feature or bug fix.
4. Run `bundle exec rake test`. If your specs pass, return to step 3.
5. Implement your feature or bug fix.
6. Run `bundle exec rake test`. If your specs fail, return to step 5.
7. Add, commit, and push your changes.
8. [Submit a pull request.][pr]
[fork]: http://help.github.com/fork-a-repo/
[branch]: http://learn.github.com/p/branching.html
[pr]: http://help.github.com/send-pull-requests/

4
LICENSE → LICENSE.md
View file

@ -1,4 +1,4 @@
Copyright (c) 2010 Thomas Reynolds
Copyright (c) 2010-2013 Thomas Reynolds
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

73
README.md
View file

@ -1,6 +1,6 @@
# Middleman
Middleman makes developing stand-alone websites simple. The last few years has seen an explosion in the amount and variety of tools developers can use to build web applications. Ruby on Rails selects a handful of these tools:
[Middleman] makes developing stand-alone websites simple. The last few years has seen an explosion in the amount and variety of tools developers can use to build web applications. Ruby on Rails selects a handful of these tools:
* Sass for DRY stylesheets
* CoffeeScript for safer and less verbose javascript
@ -11,24 +11,30 @@ Middleman gives the stand-alone developer access to all these tool and many, man
These days, many websites are built with an API in mind. Rather than package the frontend and the backend together, both can be built and deployed independently using the public API to pull data from the backend and display it on the frontend. Static websites are incredibly fast and require very little RAM. A front-end built to stand-alone can be deployed directly to the cloud or a CDN. Many designers and developers simply deliver static HTML/JS/CSS to their clients.
# Install
## Install
Middleman is built on Ruby and uses the RubyGems package manager for installation. These are usually pre-installed on Mac OS X and Linux. Windows users can install both using [RubyInstaller].
gem install middleman
```
gem install middleman
```
# Getting Started
## Getting Started
Once Middleman is installed, you will have access to the `middleman` command. First, let's create a new project. From the terminal:
middleman init MY_PROJECT
```
middleman init MY_PROJECT
```
This will create a new Middleman project located in the "MY_PROJECT" directory. This project contains a `config.rb` file for configuring Middleman and a `source` directory for storing your pages, stylesheets, javascripts and images.
Change directories into your new project and start the preview server:
cd MY_PROJECT
middleman server
```
cd MY_PROJECT
middleman server
```
The preview server allows you to build your site, by modifying the contents of the `source` directory, and see your changes reflected in the browser at: `http://localhost:4567/`
@ -38,52 +44,55 @@ For example, say I am working on a stylesheet at `source/stylesheets/site.css` a
Finally, you will want to build your project into a stand-alone site. From the project directory:
middleman build
```
middleman build
```
This will compile your templates and output a stand-alone site which can be easily hosted or delivered to your client. The build step can also compress images, employ Javascript & CSS dependency management, minify Javascript & CSS and run additional code of your choice. Take a look at the `config.rb` file to see some of the most common extensions which can be activated.
# Learn More
## Learn More
A full set of in-depth instructional guides are available on the official website at:
A full set of in-depth instructional guides are available on the official website at: http://middlemanapp.com.
http://middlemanapp.com/
Additionally, up-to-date generated code documentation is available on [RubyDoc].
Additionally, up-to-date generated code documentation is available on RubyDoc:
http://rubydoc.info/github/middleman/middleman
## Build & Dependency Status
# Community
[![Gem Version](https://badge.fury.io/rb/middleman.png)][gem]
[![Build Status](https://travis-ci.org/middleman/middleman.png)][travis]
[![Dependency Status](https://gemnasium.com/middleman/middleman.png?travis)][gemnasium]
[![Code Quality](https://codeclimate.com/github/middleman/middleman.png)][codeclimate]
The official community forum is available at:
## Community
http://forum.middlemanapp.com/
The official community forum is available at: http://forum.middlemanapp.com
# Bug Reports
## Bug Reports
GitHub Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems:
Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems: https://github.com/middleman/middleman/issues
https://github.com/middleman/middleman/issues
The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit [Pull Requests](https://help.github.com/articles/using-pull-requests) containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
# Build & Dependency Status
[![Build Status](https://travis-ci.org/middleman/middleman.png)](https://travis-ci.org/middleman/middleman)
[![Dependency Status](https://gemnasium.com/middleman/middleman.png?travis)](https://gemnasium.com/middleman/middleman)
# How to Run Cucumber Tests
## How to Run Cucumber Tests
1. Checkout Repository: `git clone https://github.com/middleman/middleman.git`
2. Install Bundler: `gem install bundler`
3. Run `bundle install` inside the project root to install the gem dependencies.
4. Run test cases: `bundle exec rake test`
# Donate
## Donate
[Click here to lend your support to Middleman](https://spacebox.io/s/4dXbHBorC3)
# License
## License
Copyright (c) 2010 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
Copyright (c) 2010-2013 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
[RubyInstaller]: http://rubyinstaller.org/
[LICENSE]: https://github.com/middleman/middleman/blob/master/LICENSE
[middleman]: http://middlemanapp.com
[gem]: https://rubygems.org/gems/middleman
[travis]: http://travis-ci.org/middleman/middleman
[gemnasium]: https://gemnasium.com/middleman/middleman
[codeclimate]: https://codeclimate.com/github/middleman/middleman
[rubyinstaller]: http://rubyinstaller.org/
[rubydoc]: http://rubydoc.info/github/middleman/middleman
[LICENSE]: https://github.com/middleman/middleman/blob/master/LICENSE.md

1
middleman-core/middleman-core.gemspec
View file

@ -11,6 +11,7 @@ Gem::Specification.new do |s|
s.homepage = "http://middlemanapp.com"
s.summary = "Hand-crafted frontend development"
s.description = "A static site generator. Provides dozens of templating languages (Haml, Sass, Compass, Slim, CoffeeScript, and more). Makes minification, compression, cache busting, Yaml data (and more) an easy part of your development cycle."
s.license = "MIT"
s.files = `git ls-files -z`.split("\0")
s.test_files = `git ls-files -z -- {fixtures,features}/*`.split("\0")

1
middleman/middleman.gemspec
View file

@ -12,6 +12,7 @@ Gem::Specification.new do |s|
s.homepage = "http://middlemanapp.com"
s.summary = "Hand-crafted frontend development"
s.description = "A static site generator. Provides dozens of templating languages (Haml, Sass, Compass, Slim, CoffeeScript, and more). Makes minification, compression, cache busting, Yaml data (and more) an easy part of your development cycle."
s.license = "MIT"
s.files = `git ls-files -z`.split("\0")
s.test_files = `git ls-files -z -- {fixtures,features}/*`.split("\0")