Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 48 lines (39 sloc) 2.538 kb
d39beff @rgrove Prettier README and LICENSE for GitHub.
rgrove authored
1 YUI 3: The Yahoo! User Interface Library
2 ========================================
3
4 Welcome to YUI 3!
5
6 * [Documentation](http://developer.yahoo.com/yui/3/)
7 * [Latest Production Release](http://yuilibrary.com/downloads/#yui3)
8 * [Forums](http://yuilibrary.com/forum/)
9 * [License](http://developer.yahoo.com/yui/license.html)
10 * [Contributor Info](http://developer.yahoo.com/yui/community/contribute.html)
11
12 The YUI Library is a set of utilities, infrastructure components, and widgets
13 written in JavaScript and CSS for building richly interactive web applications.
14 It is available under a BSD license and is free for all uses.
15
16 This is the active working source tree for YUI 3. It contains work in progress
17 toward the next YUI 3 release, and may be unstable or change without notice. We
18 encourage you to use the latest source for evaluation purposes, testing new
19 features and bug fixes, and to provide feedback on new functionality. Please
20 refer to the "Latest Production Release" link above if you're looking for the
21 latest stable release of YUI recommended for production use.
22
23 The YUI source tree includes the following directories:
24
25 * `api`: Generated API docs for the entire library in HTML format. This
26 documentation is built and committed automatically from the contents of the
27 `src` directory.
28 * `build`: Built YUI source files. The built files are generated at
29 development time from the contents of the `src` directory. The build step
30 generates debug files (unminified and with full comments and logging),
31 raw files (unminified, but without debug logging), and minified files
32 (suitable for production deployment and use).
33 * `sandbox`: Experiments and works in progress, including unreleased future
34 components. Here there be dragons.
35 * `src` Raw unbuilt source code (JavaScript, CSS, image assets, ActionScript
36 files, etc.) for the library. Beginning with YUI 3.4.0, the `src` directory
37 also contains all module-specific documentation, tests and examples. All
38 modifications to the library and its documentation should take place in
39 this directory.
40
41 The individual component directories under the `src` directory contain Ant
42 build files (`build.xml` and others) which can be used to build individual
43 modules using the YUI Builder. The YUI Builder is part of the "builder" project,
44 also available on GitHub at <https://github.com/yui/builder>
45
46 The `README` file in the `componentbuild` directory of the Builder project
47 covers the installation and use of the build tool.
Something went wrong with that request. Please try again.