README.rdoc in netzke-basepack-0.5.8 vs README.rdoc in netzke-basepack-0.5.9
- old
+ new
@@ -1,9 +1,9 @@
= netzke-basepack
A pack of basic Rails/ExtJS widgets as a part of the Netzke framework. Live demo/tutorials on http://blog.writelesscode.com. Introduction to the Netzke framework and the Wiki: http://github.com/skozlov/netzke
-= Prerequisites
+== Prerequisites
1. Rails >= 2.2
2. Netzke assumes that your ExtJS library is in public/extjs, which may be a symbolic link, e.g:
cd public && ln -s ~/Developer/extjs/ext-3.1.1 extjs
@@ -26,23 +26,27 @@
Or install as gem:
gem install netzke-basepack
-= Usage
+== Usage
If using as gem, include it into environment.rb:
config.gem "netzke-basepack"
Include mapping for Netzke controller providing Netzke javascripts and styles (in routes.rb):
map.netzke
-To be able to use persistent on-the-fly configuration of widgets, run netzke-core generators to have the necessary migrations:
+Run the generators (some assets and a migration for dynamically configured columns/fields):
+
+ ./script/generate netzke_basepack
- ./script/generate netzke_core
+To be able to use persistent on-the-fly configuration of widgets, run netzke-core generators:
+ ./script/generate netzke_core
+
... then run the migrations:
rake db:migrate
== Embedding widgets into Rails' view
@@ -61,9 +65,12 @@
Now embed a widget into a view like this:
<%= netzke :books, :class_name => 'GridPanel', :model => 'Book' %>
For more examples, see http://netzke-demo.writelesscode.com
+
+== Icons support
+Netzke-basepack supports FamFamFam Silk icon set (http://www.famfamfam.com/archive/silk-icons-thats-your-lot/). To enable it, download it and put the "icons" folder into your app's public/images folder. Then restart your application.
== More info
Introduction to Netzke framework and wiki: http://github.com/skozlov/netzke
Twitter: http://twitter.com/skozlov