Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Mmmmm, Markdown

  • Loading branch information...
commit c57c70be4609fccc12d61d46b66f5d99c0b4e833 1 parent 3462d89
@jordelver jordelver authored
Showing with 29 additions and 28 deletions.
  1. +0 −28 README
  2. +29 −0 README.md
View
28 README
@@ -1,28 +0,0 @@
-CREATING A NEW NOODALL COMPONENT
-
-Instructions for extracting/creating a Noodall component gem
-
-SETUP
-Generate a new component/plugin template
-
- rails plugin new noodall-component-<name> --full -Om https://raw.github.com/stengland/noodall-plugin-template/master/template.rb
-
- This generates a Rails Engine and applies our customisations.
-
-
-PROCESS
-Copy/create models in app/models
-
-Copy/create views in app/views/admin/components and app/views/components
-
-Setup slots for the new component under: test/dummy/config/initializers/noodall.rb
-
-Add new slots to test/dummy/app/models/content_page.rb
-
-Add the new component slot to test/dummy/app/views/nodes/content_page.html.erb
-
-Add cucumber tests and/or unit tests
-
-Setup factories in /factories
-
-Fill in the *.gemspec file
View
29 README.md
@@ -0,0 +1,29 @@
+Creating a New Noodall Component
+================================
+Instructions for extracting/creating a Noodall component gem
+
+Setup
+-----
+Generate a new component/plugin template
+
+ * `rails plugin new noodall-component-<name> --full -Om https://raw.github.com/stengland/noodall-plugin-template/master/template.rb`
+
+This generates a Rails Engine and applies our customisations.
+
+Process
+-------
+* Copy/create models in `app/models`
+
+* Copy/create views in `app/views/admin/components` and `app/views/components`
+
+* Setup slots for the new component under `test/dummy/config/initializers/noodall.rb`
+
+* Add new slots to `test/dummy/app/models/content_page.rb`
+
+* Add the new component slot to `test/dummy/app/views/nodes/content_page.html.erb`
+
+* Add cucumber tests and/or unit tests
+
+* Setup factories in `/factories`
+
+* Fill in the `*.gemspec` file
Please sign in to comment.
Something went wrong with that request. Please try again.