Permalink
Browse files

formatting of README

  • Loading branch information...
1 parent c37179f commit f15b022f3d61d7e6d7415af4e39c478bb37e556b @mediavrog committed Nov 21, 2010
Showing with 31 additions and 42 deletions.
  1. 0 ChangeLog → ChangeLog.rdoc
  2. +0 −42 README
  3. +31 −0 README.rdoc
File renamed without changes.
View
42 README
@@ -1,42 +0,0 @@
-README FOR Custom Form Elements
-****************************************************
-
-1. What is/are Custom Form Elements?
-°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-Custom Form Elements unites all efforts in the web to enhance web-based XHTML forms
-in terms of style, usability and accessibility by using Javascript and/or CSS.
-Basically, it's a UI library.
-
-2. Requirements to use CFE
-°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-JavaScript-compatible Browser see => http://customformelements.net for a list of supported browsers
-
-Custom Form Elements are based on various Javascript Framworks. Currently these are supported:
- * Mootools 1.1 [deprecated]
- * Mootools 1.2
-
-
-3. What should you do if you have a problem?
-°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-Found any bugs? Please report using the bugtracker on SouceForge.net => http://sourceforge.net/tracker/?group_id=225918
-Get help or help others in the forum of cfe on SouceForge.net => http://sourceforge.net/projects/cfe/forums
-Browse the freshest code fragments on SouceForge.net => http://cfe.svn.sourceforge.net/viewvc/cfe/ [NOTE: may be unstable; use at own risk]
-
-X. Kudos
-°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°°
-
-CFE would be nothing without the work of other great developers and designers.
-I'd like to thank you for giving me the opportunity to realize this project,
-as you build the basement for all this!
-
-Kudos to all developers!
-
-
-Custom Form Elements uses icons from the Fugue icon set, which are
-distrubuted by Yusuke Kamiyamane on http://p.yusukekamiyamane.com/ under the
-Creative Commons Attribution 3.0 license [http://creativecommons.org/licenses/by/3.0/]
-
-Great work Yusuke!!
-
-NOTE: If you use those icons on your site, you've got to somehow link back to him
-as his work is licenced under Creative Commons Attribution 3.0 License
View
@@ -0,0 +1,31 @@
+= Custom Form Elements for *mootools 1.2*
+
+Custom Form Elements unites all efforts in the web to enhance web-based XHTML forms
+in terms of style, usability and accessibility by using Javascript and/or CSS.
+Basically, it's a UI library.
+
+Some resources to get you started:
+
+* {Installation instructions}[http://github.com/mediavrog/cfe/wikis/installation]
+ on {the wiki}[http://github.com/mediavrog/cfe/wikis]
+* Got questions? Join our
+ {Google group}[http://groups.google.com/group/custom-form-elements].
+* {How to report bugs}[http://github.com/mediavrog/cfe/wikis/report-bugs]
+
+== Compatibility
+
+JavaScript-compatible A-grade Browsers
+ TODO: Add Table
+
+== Example usage
+
+See cfe/cfe.autostart.sample.js
+
+== Authors and credits
+
+Authors:: Maik Vlcek
+Iconset:: Fugue Icon Set by Yusuke Kamiyamane http://p.yusukekamiyamane.com/ (CC3.0 Attribution)
+
+CFE would be nothing without the work of other great developers and designers.
+I'd like to thank you for giving me the opportunity to realize this project,
+as you build the basement for all this!

0 comments on commit f15b022

Please sign in to comment.