jenkins-bot has submitted this change and it was merged. Change subject: README: Add "Loading the library" wherein we apologise for the mess that is the dist/ directory ......................................................................
README: Add "Loading the library" wherein we apologise for the mess that is the dist/ directory Change-Id: I366d97b3e76bd33bedb56766b03dabd3495edeb6 --- M README.md 1 file changed, 16 insertions(+), 0 deletions(-) Approvals: Jforrester: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md index 1bcd954..9ef450a 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,22 @@ 1. You can see a suite of demos in `/demos` by executing:<br/>`$ npm run-script demos` +Loading the library +------------------- + +While the distribution directory is chock-full of files, you will normally only need to load three: + +* `oojs-ui.js` containing the full library +* `oojs-ui-apex.css` or `oojs-ui-mediawiki.css` containing theme-specific styles +* `oojs-ui-apex.js` or `oojs-ui-mediawiki.js` containing theme-specific code + +You can load additional icons packs from files named `oojs-ui-apex-icons-*.css` or `oojs-ui-mediawiki-icons-*.css`. + +The remaining files make it possible to load only parts of the whole library. + +Furthermore, every CSS file has a right-to-left (RTL) version available, to be used on pages using right-to-left languages. + + Versioning ---------- -- To view, visit https://gerrit.wikimedia.org/r/267130 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I366d97b3e76bd33bedb56766b03dabd3495edeb6 Gerrit-PatchSet: 1 Gerrit-Project: oojs/ui Gerrit-Branch: master Gerrit-Owner: Bartosz Dziewoński <[email protected]> Gerrit-Reviewer: Jforrester <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
