include/javascript/yui3/README

   1 YUI 3.x Library Source
   2
   3 * Documentation: http://developer.yahoo.com/yui/3/
   4 * License: http://developer.yahoo.com/yui/license.html
   5 * Latest Stable Release: http://yuilibrary.com/downloads/
   6 * Discuss: http://yuilibrary.com/forum/
   7 * Contributor Info: http://developer.yahoo.com/yui/community/contribute.html
   8
   9 Welcome to YUI.
  10
  11 The YUI Library is a set of utilities and controls, written in JavaScript,
  12 for building richly interactive web applications using techniques such
  13 as DOM scripting, DHTML and AJAX. YUI is available under a BSD license
  14 and is free for all uses.
  15
  16 This is the source tree for YUI's 3.x codeline which is has been released
  17 as a technical preview and is not considered ready for production use.
  18 The production codeline for YUI is YUI 2.x; http://developer.yahoo.com/yui/
  19 is the main YUI website.
  20
  21 The source tree for YUI includes the following directories:
  22
  23 * api: Generated API docs for the entire library in HTML format.  These
  24      documents are build using YUI Doc from the contents of the src
  25      directory.
  26 * build: Generated/built YUI files.  The built files are generated from
  27      the contents of the src directory.  Files are provided in full,
  28      commented form (suitable for debugging) and in minified form
  29      (suitable for deployment and use).
  30 * sandbox: The sandbox directory contains works-in-progress, including
  31      unreleased future components, as well as experimental and/or
  32      demonstration code created by library authors.
  33 * src: This directory contains the source code (JavaScript, CSS, image
  34      assets, ActionScript files) for the library. src also contains (or
  35      will contain) all module-specific documentation, tests and examples.
  36      All modifications to the library and its documentation should take
  37      place in this directory.
  38
  39      The src directory also contains build.xml files, which can be
  40      used to build individual modules using the YUI component build
  41      tool. The YUI component build tool is part of the YUI "builder"
  42      project, also available on GitHub:
  43
  44          http://github.com/yui/builder
  45
  46      The README in the componentbuild directory of the builder project
  47      covers installation and use of the build tool.
  48
  49 Code found in the development head is always a work in progress and
  50 should be treated as experimental.