|
1 YUI 3: The Yahoo! User Interface Library |
|
2 ======================================== |
|
3 |
|
4 YUI is a free, open source JavaScript and CSS framework for building richly |
|
5 interactive web applications. YUI is provided under a BSD license and is |
|
6 available on GitHub for forking and contribution. |
|
7 |
|
8 Links |
|
9 ----- |
|
10 |
|
11 * [Home Page](http://yuilibrary.com/) |
|
12 * [Documentation](http://yuilibrary.com/yui/docs/) |
|
13 * [Latest Production Release](http://yuilibrary.com/download/yui3/) |
|
14 * [Forums](http://yuilibrary.com/forum/) |
|
15 * [License](http://yuilibrary.com/license/) |
|
16 * [Contributor Info](http://yuilibrary.com/contribute/) |
|
17 * [Report a Bug](http://yuilibrary.com/yui/docs/tutorials/report-bugs/) |
|
18 * [](http://travis-ci.org/yui/yui3) |
|
19 * [Shifter, for building YUI](http://yui.github.com/shifter/) |
|
20 |
|
21 |
|
22 Source Info |
|
23 ----------- |
|
24 |
|
25 This is the active working source tree for YUI 3. It contains work in progress |
|
26 toward the next YUI 3 releases and may be unstable. |
|
27 |
|
28 We encourage you to use the latest source for evaluation purposes, testing new |
|
29 features and bug fixes, and to provide feedback on new functionality. Please |
|
30 refer to the "Latest Production Release" link above if you're looking for the |
|
31 latest stable release of YUI recommended for production use. |
|
32 |
|
33 ### Branches |
|
34 |
|
35 YUI's development happens on three main branches. The following describes what |
|
36 each of these code branches represents: |
|
37 |
|
38 * `live-docs`: Represents the latest release of YUI, plus any |
|
39 documentation-only updates. Any tweaks or additions to the docs for the |
|
40 latest release happen on this branch, and they are reflected on the website. |
|
41 |
|
42 * `master`: Contains everything in `live-docs`, plus code changes that will go |
|
43 into the next YUI release. The code changes in `master` are either bug fixes |
|
44 or small changes which should not break API compatibility. Patch releases |
|
45 will be cut from this branch; e.g. 3.6.x. |
|
46 |
|
47 * `3.x`: Represents the next major YUI release; e.g. 3.7.0. This is an |
|
48 integration branch which contains everything in `master`, plus larger code |
|
49 changes which will go into a future YUI release. The changes in `3.x` |
|
50 require a minor version increment before they are part of release; e.g. |
|
51 3.7.0. Preview Releases will be cut from this branch for developers to test |
|
52 and evaluate. |
|
53 |
|
54 ### Source Tree |
|
55 |
|
56 The YUI source tree includes the following directories: |
|
57 |
|
58 * `build`: Built YUI source files. The built files are generated at |
|
59 development time from the contents of the `src` directory. The build step |
|
60 generates debug files (unminified and with full comments and logging), |
|
61 raw files (unminified, but without debug logging), and minified files |
|
62 (suitable for production deployment and use). |
|
63 |
|
64 * `src` Raw unbuilt source code (JavaScript, CSS, image assets, ActionScript |
|
65 files, etc.) for the library. Beginning with YUI 3.4.0, the `src` directory |
|
66 also contains all module-specific documentation, tests and examples. All |
|
67 modifications to the library and its documentation should take place in |
|
68 this directory. |
|
69 |
|
70 To build YUI components install [Shifter](http://yui.github.com/shifter/) (`npm -g install shifter`) |
|
71 and then simply run `shifter` in that components directory. |
|
72 |
|
73 Shifter also allows you to rebuild the entire YUI src tree: |
|
74 |
|
75 cd yui3/src && shifter --walk |
|
76 |
|
77 |