Update README.md
Didier Lafforgue
committed Jan 08, 2013
commit 046c0882726e02a3e5bd714e4861890c955cfd94
Showing 1
changed file with
50 additions
and 11 deletions
README.md
+50
-11
| @@ | @@ -1,24 +1,45 @@ |
| - | # Locomotive::Builder |
| + | # LocomotiveCMS::Builder |
| - | TODO: Write a gem description |
| + | The LocomotiveCMS builder is a site generator for the LocomotiveCMS engine powered by all the efficient and modern HTML development tools (Haml, SASS, Compass, Less). |
| - | ## Installation |
| + | (TO BE COMPLETED) |
| - | Add this line to your application's Gemfile: |
| + | ## Developers / Alpha users / Contributors |
| - | gem 'locomotive_builder' |
| + | The push/pull functionalities require to have the edge version of the engine (master branch). |
| + | Also, please, keep in mind, that is nearly an alpha version so it is not stable enough to be used in production. |
| - | And then execute: |
| + | ### Get the development of the mounter |
| - | $ bundle |
| + | $ git clone git://github.com/locomotivecms/mounter.git |
| - | Or install it yourself as: |
| + | Note: If you want to contribute, you may consider to fork it instead |
| - | $ gem install locomotive_builder |
| + | ### Get the source of the builder |
| - | ## Usage |
| + | $ git clone git://github.com/locomotivecms/builder.git |
| + | $ cd builder |
| + | $ git checkout wip |
| - | TODO: Write usage instructions here |
| + | Note: Again, if you want to contribute, you may consider to fork it instead |
| + | |
| + | Modify the Gemfile to change the link to the *mounter* gem which should point to your local installation of the mounter. |
| + | |
| + | $ bundle install |
| + | |
| + | ### Test it |
| + | |
| + | #### Run the server with a default site |
| + | |
| + | $ bundle exec bin/builder server <path to the mounter gem>/spec/fixtures/default |
| + | |
| + | #### Push a site (WIP) |
| + | |
| + | $ bundle exec bin/builder push <path to your LocomotiveCMS local site> <url of your remote LocomotiveCMS site> <email of your admin account> <password> |
| + | |
| + | #### Pull a site (Not tested yet) |
| + | |
| + | $ bundle exec bin/builder pull <url of your remote LocomotiveCMS site> <email of your admin account> <password> |
| ## Contributing | |
| @@ | @@ -27,3 +48,21 @@ TODO: Write usage instructions here |
| 3. Commit your changes (`git commit -am 'Add some feature'`) | |
| 4. Push to the branch (`git push origin my-new-feature`) | |
| 5. Create new Pull Request | |
| + | |
| + | ## Installation (TODO) |
| + | |
| + | Add this line to your application's Gemfile: |
| + | |
| + | gem 'locomotive_builder' |
| + | |
| + | And then execute: |
| + | |
| + | $ bundle |
| + | |
| + | Or install it yourself as: |
| + | |
| + | $ gem install locomotive_builder |
| + | |
| + | ## Usage |
| + | |
| + | TODO: Write usage instructions here |