From f808e9f4000a080308aec081622250776efdd497 Mon Sep 17 00:00:00 2001 From: Peter Gumeson Date: Thu, 23 May 2013 16:44:40 -0700 Subject: [PATCH] Update readme with new contributing instructions --- CONTRIBUTING.md | 21 +++++++++++++++++++-- README.md | 4 ++-- 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 664d11f5..6d63f874 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,21 @@ -# Contributing to bootstrap-sass +# Contributing to bootstrap-sass + +## Upstream Converter + +Upsteam changes to the Twitter Bootstrap project can be pulled in using the `convert` rake task. + +Here's an example run that would pull down the `3.0.0-wip` branch from the main twitter/bootstrap repo: + + % bundle exec rake 'convert[3.0.0-wip]' + +The latest converter script is located [here](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/tasks/converter.rb) and attempts to do the following: + +* Convert upsteam bootstrap Less files to the matching Scss file. +* TODO: Copy upstream javascript, images and other assets into the bootstrap-sass assets directory. + +This conversion is not perfect at this time so manual fixes to the resulting Scss will necessary. +See [these github issues](https://github.com/intridea/bootstrap-sass/issues?labels=converter&state=open) tagged with `conversion` which track the current shortcomings of the conversion process. + ## Bugs @@ -68,4 +85,4 @@ Please **do not** use the issue tracker for personal support requests (use Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others. -*props [html5-boilerplate](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md)* \ No newline at end of file +*props [html5-boilerplate](https://github.com/h5bp/html5-boilerplate/blob/master/CONTRIBUTING.md)* diff --git a/README.md b/README.md index 7e24f2c6..9d0bf789 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,6 @@ Welcome to the 3 branch. -3 might be complete in places, but stuff will break. +## Conversion -This certainly won't be merged into master (and the commit messages will be horrible) since we will pull from jlong/sass-twitter-bootstrap as per usual, but this is an attempt so you can see and try out Bootstrap 3 with you application. \ No newline at end of file +If you'd like to help out with the conversion to Twitter Bootstrap 3, please read about how to use the new converter script in the [CONTRIBUTING README](https://github.com/intridea/bootstrap-sass/blob/3.0.0-wip/CONTRIBUTING.md).