jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/353209 )
Change subject: README: Clarify and simplify descriptions ...................................................................... README: Clarify and simplify descriptions Change-Id: I22362b1907fdd1246a5bac1dc0aec97e322eb80a --- M README.md 1 file changed, 10 insertions(+), 10 deletions(-) Approvals: jenkins-bot: Verified Jforrester: Looks good to me, approved diff --git a/README.md b/README.md index 5cbc067..7880570 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ OOjs UI ================= -OOjs UI is a modern JavaScript UI toolkit for browsers. It provides a library of common widgets, layouts and windows that are ready to use, as well as many foundational classes for constructing custom user interfaces. The library was originally created for use by [VisualEditor](https://www.mediawiki.org/wiki/VisualEditor), which uses it for its entire user interface, and is now completely independent, and more useful and convenient for other use cases. +OOjs UI is a modern JavaScript UI toolkit. It provides common widgets, layouts, dialogs and icons that are ready to use, as well as many useful and convenient classes for constructing custom user interfaces. It is the standard user-interface libary in Wikimedia Foundation web products and was originally created for use by [VisualEditor](https://www.mediawiki.org/wiki/VisualEditor), which uses it for its entire user interface. Quick start ---------- @@ -17,17 +17,17 @@ 1. Clone the repo and move into it, `$ git clone https://phabricator.wikimedia.org/diffusion/GOJU/oojs-ui.git oojs-ui && cd oojs-ui`. -2. Install Grunt command-line utility:<br/>`$ npm install -g grunt-cli` +2. Install Grunt command-line utility:<br>`$ npm install -g grunt-cli` 3. Install [composer](https://getcomposer.org/download/) and make sure running `composer` will execute it (*e.g.* add it to `$PATH` in POSIX environments). -4. Install dev dependencies:<br/>`$ npm install` +4. Install dev dependencies:<br>`$ npm install` -5. Build the library (you can alternatively use `grunt quick-build` if you don't need to rebuild the PNGs):<br/>`$ grunt build` +5. Build the library (you can alternatively use `grunt quick-build` if you don't need to rebuild the PNGs):<br>`$ grunt build` 6. You can now copy the distribution files from the dist directory into your project. -7. You can see a suite of demos in `/demos` by executing:<br/>`$ npm run-script demos` +7. You can see a suite of demos in `/demos` by executing:<br>`$ npm run-script demos` Loading the library @@ -36,10 +36,10 @@ While the distribution directory is chock-full of files, you will normally only need to load three: * `oojs-ui.js`, containing the full library -* One of `oojs-ui-apex.css` or `oojs-ui-mediawiki.css`, containing theme-specific styles -* One of `oojs-ui-apex.js` or `oojs-ui-mediawiki.js`, containing theme-specific code +* One of `oojs-ui-mediawiki.css` or `oojs-ui-apex.css`, containing theme-specific styles +* One of `oojs-ui-mediawiki.js` or `oojs-ui-apex.js`, containing theme-specific code -You can load additional icon packs from files named `oojs-ui-apex-icons-*.css` or `oojs-ui-mediawiki-icons-*.css`. +You can load additional icon packs from files named `oojs-ui-mediawiki-icons-*.css` or `oojs-ui-apex-icons-*.css`. The remaining files make it possible to load only parts of the whole library. @@ -61,7 +61,7 @@ Issue tracker ------------- -Found a bug or missing feature? Please report it in the [issue tracker](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=PHID-PROJ-dgmoevjqeqlerleqzzx5)! +Found a bug or missing feature? Please report it in our [issue tracker Phabricator](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=PHID-PROJ-dgmoevjqeqlerleqzzx5)! Contributing @@ -69,7 +69,7 @@ We are always delighted when people contribute patches. We recommend a few things to make it quicker and easier for you to contribute: -* You will need a [wikitech account](https://wikitech.wikimedia.org/w/index.php?title=Special:UserLogin&returnto=Help%3AGetting+Started&type=signup) which you can use to login to [gerrit](https://gerrit.wikimedia.org/), our code review system. +* You will need a [Wikitech account](https://wikitech.wikimedia.org/w/index.php?title=Special:UserLogin&returnto=Help%3AGetting+Started&type=signup) which you can use to login to [Gerrit](https://gerrit.wikimedia.org/), our code review system. * You will need a [Wikimedia account](https://www.mediawiki.org/w/index.php?title=Special:UserLogin&type=signup), which you can [use to login to Phabricator](https://www.mediawiki.org/w/index.php?title=Special:UserLogin&returnto=Special%3AOAuth%2Fauthorize&returntoquery=oauth_token%3D2fa60627878b83173e0196040b983326%26oauth_consumer_key%3D038ec949b263dc807b0079fd88538f37). * You should [create a Phabricator ticket](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?projects=PHID-PROJ-dgmoevjqeqlerleqzzx5) describing the issue you wish to change. * We automatically lint and style-check changes to JavaScript, PHP, CSS, Ruby and JSON files. You can test these yourself with `npm test` and `composer test` locally before pushing changes. SVG files should be squashed in advance of committing with [SVGO](https://github.com/svg/svgo) using `svgo --pretty --disable=removeXMLProcInst --disable=cleanupIDs <filename>`. -- To view, visit https://gerrit.wikimedia.org/r/353209 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I22362b1907fdd1246a5bac1dc0aec97e322eb80a Gerrit-PatchSet: 2 Gerrit-Project: oojs/ui Gerrit-Branch: master Gerrit-Owner: VolkerE <volke...@wikimedia.org> Gerrit-Reviewer: Jforrester <jforres...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
