Permalink
Browse files

FLUID-4251: Improvements to the README and release notes, as well as …

…a new readme for the build system.
  • Loading branch information...
1 parent 9106cfa commit 11ec3fac8c562d6085a41bdf81ad1c0d79250f44 @colinbdclark colinbdclark committed Jul 25, 2011
Showing with 87 additions and 46 deletions.
  1. +7 −10 README.txt
  2. +35 −36 ReleaseNotes.txt
  3. +45 −0 build-scripts/build-README.txt
View
@@ -1,36 +1,33 @@
What Is Infusion?
=================
-Infusion is a different kind of JavaScript framework. Our approach is to leave you in control
+Infusion is a different kind of JavaScript framework. Our approach is to leave you in control--
it's your interface, using your markup, your way. Infusion is accessible and very, very configurable.
Infusion includes:
- * an application framework for developing flexible interfaces with JavaScript and jQuery,
- * a growing collection of user interface components, and
- * a lightweight CSS framework.
+ * an application framework for developing flexible stuff with JavaScript and jQuery
+ * a collection of accessible UI components
+ * a lightweight CSS framework
Where Can I See Infusion Components?
====================================
-We have a convenient, one-stop-shop for seeing all our components in action:
-
http://fluidproject.org/products/infusion/infusion-demos/
How Do I Get Infusion?
======================
-You can create your own custom build of Infusion using the new Infusion Builder:
+You can create your own custom build of Infusion using the Infusion Builder:
http://builder.fluidproject.org
Who Makes Infusion, and How Can I Help?
=======================================
-The Fluid community is an international group of designers, developers, volunteers, and advisers
-who focus on a common mission: improving the user experience of community and open source web
-applications.
+The Fluid community is an international group of designers, developers, and testers who focus on a
+common mission: improving the user experience and accessibility of the open web.
The best way to join the Fluid Community is to jump in to any of our community activities.
Visit our "Get Involved" page for links to our mailing lists, chat room, wiki, etc.:
View
@@ -8,33 +8,40 @@ Documentation: http://wiki.fluidproject.org/display/docs/Infusion+Documenta
What's New in 1.4?
==================
- * FSS fixes and improvements
- * UI Options redesign
- * jQuery UI library updated to 1.8.12
- * jQuery UI accordion widget is no longer a dependency and will not be included in your bundle
-
-What's in this Release?
-=======================
+ * Many improvements to the Fluid Skinning system, including:
+ - A new more modular reset system, including support for contextualized resets
+ - Easier to override: !importants have been removed
+ - New themes for accessibility
+ - More layout container sizes (thanks to Gary Thompson and Unicon)
+ - Expanded documentation and examples
+ - A new FSS contributor gallery with portlet and form styles:
+ http://wiki.fluidproject.org/display/fluid/Fluid+Contributor+Gallery
+ * Shiny new UI Options component
+ * Improved user experience for Uploader, including error handling
+ * Substantial improvements to the Infusion IoC system
+ * Updated versions of jQuery and jQuery UI
+
+Downloading Infusion
+======================
-This release is available in two ways:
+You can create your own custom build of Infusion using the Infusion Builder:
- 1) Create your own custom build, using the new Infusion Builder
- http://builder.fluidproject.org
+ http://builder.fluidproject.org
- 2) Alternatively, you can download a source code release from Github:
- https://github.com/fluid-project/infusion
- (this will include our tests)
+An all-in-one version of Infusion's JavaScript code, MyInfusion.js, can be
+found at the top level of the distribution. When you put your application into
+production, use the Builder to create a minified version of Infusion.
+
+For development, you can download the Infusion source code from Github:
-If you use the Infusion Builder, your download will include at the top level a single JavaScript file,
- MyInfusion.js
-which is a combination of all requested source files. Developers can include this single file in
-their pages to provide all the necessary support for the Infusion component Library. You can elect
-to have this file minified (for a production environment) or not (for development).
+ https://github.com/fluid-project/infusion
+
-Demo Portal
------------
-The bundle now comes with a convenient one-stop-shop for seeing all components in action. You can
-find the demo portal in the "demos" folder in the release bundle or on our Website at:
+Demos
+=====
+
+Infusion ships with a demo portal for seeing all components in action. You can
+find it in the "demos" folder in the release bundle or on our web site at:
http://fluidproject.org/products/infusion/infusion-demos/
@@ -43,27 +50,20 @@ if you're using Firefox 3 and higher. Here's more information:
http://kb.mozillazine.org/Security.fileuri.strict_origin_policy
http://ejohn.org/blog/tightened-local-file-security/
-
-Please note that the tests in the "manual-tests" folder are deprecated, and are being
-converted into unit tests. Any remaining tests in that folder may not function properly.
License
--------
-Fluid Infusion code is licensed under both the ECL 2.0 and new BSD licenses. The specific licenses can be
-found in the license file:
- licenses/Infusion-LICENSE.txt
+=======
-Infusion also depends upon some third party open source modules. These are contained in their own
-folders, and their licenses are also present in
- licenses/
-
-More information about Infusion licensing is available in our wiki:
+Fluid Infusion is licensed under both the ECL 2.0 and new BSD licenses.
+
+More information is available in our wiki:
http://wiki.fluidproject.org/display/fluid/Fluid+Licensing
Third Party Software in Infusion
---------------------------------
+================================
+
This is a list of publicly available software that is redistributed with Fluid Infusion,
categorized by license:
@@ -218,7 +218,6 @@ UI Options:
Uploader:
FLUID-3996: Deleting files on the local filesystem after they have been added to the Uploader's queue will cause inconsistent behaviour
FLUID-3997: Can't tab to the "Browse/Add More" button with the keyboard in IE with Flash 10
- FLUID-3999: "Add more" button is not disabled while uploading other files in HTML5-compliant browsers
FLUID-2052: Cannot tab away from the "Browse Files" button with Flash 10*
* For information related to known issues with Flash 10 compatibility,
see http://wiki.fluidproject.org/x/kwZo
@@ -0,0 +1,45 @@
+Infusion Build System
+=====================
+
+The Infusion build system is a collection of Ant, Maven, and JavaScript-based scripts that are responsible
+for managing dependencies between parts of Infusion, concatenating and minifying scripts, and creating release
+packages of Infusion.
+
+Builder
+=======
+
+In most cases, users can use the Infusion Builder, a web application designed to easily create custom
+packages of Infusion based only on the things you need. The Builder is available on our web site at:
+
+http://builder.fluidproject.org/
+
+A daily version of Builder is also available, which will build the latest daily development version of
+Infusion directly from our Github repository:
+
+http://build.fluidproject.org/infusionBuilder/html/InfusionBuilder.html
+
+Command Line Builds
+===================
+
+In rare cases, you may want to make a custom build of Infusion using our command line tools. In particular,
+you need to use the command line if you'd like to exclude certain parts of Infusion from your build (for example,
+jQuery). Here's how:
+
+http://wiki.fluidproject.org/display/fluid/Custom+Infusion+Builds+With+Ant
+
+Installing the Infusion Build Scripts
+=====================================
+
+To run the Infusion build scripts, you'll need to set up the following:
+
+1. The latest version of Ant
+ a. Download it from http://ant.apache.org
+ b. Replace the default installation that may have shipped with your machine (/usr/share/ant on Mac OS X)
+ c. Run ant -f fetch.xml to fetch Ant's optional tasks
+ d. Remove the version of Rhino that ships with Ant (js.jar in ant/lib)
+2. Maven
+ a. Download it from http://maven.apache.org/download.html
+ b. Follow the installation instructions at http://maven.apache.org/download.html#Installation
+3. A clone of Infusion "git clone git://github.com/fluid-project/infusion.git"
+
+

0 comments on commit 11ec3fa

Please sign in to comment.