jenkins-bot has submitted this change and it was merged. Change subject: Spruce up VisualEditor's README file. ......................................................................
Spruce up VisualEditor's README file. Convert to Markdown, for better rendering in github. Link more prominently to install instructions in the README, also mention Gerrit and the code style and API documentation. Change-Id: I8e26fea108c32f37078e363f1af18eaf28b83516 --- A README.md D README.txt 2 files changed, 28 insertions(+), 11 deletions(-) Approvals: Catrope: Looks good to me, approved jenkins-bot: Verified diff --git a/README.md b/README.md new file mode 100644 index 0000000..609f80c --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# VisualEditor + +VisualEditor provides a visual editor for wiki pages. It is written in +JavaScript and runs in a web browser. + +It uses the Parsoid parser to convert wikitext documents to annotated HTML +which the VisualEditor is able to load, modify and emit back to Parsoid at +which point it is converted back into wikitext. + +For more information about these projects, check out the [VisualEditor][] +and [Parsoid][] pages on mediawiki. + + +## Developing and installing + +For information on installing VisualEditor on a local wiki, please +see https://www.mediawiki.org/wiki/Extension:VisualEditor + +For information about contributing code to VisualEditor, see +[CODING.md][]. Patch submissions are reviewed and managed with +[Gerrit][]. There is also [API documentation][] available for the +VisualEditor. + +[VisualEditor]: http://www.mediawiki.org/wiki/VisualEditor +[Parsoid]: http://www.mediawiki.org/wiki/Parsoid +[CODING.md]: CODING.md +[API documentation]: https://doc.wikimedia.org/VisualEditor/master/ +[Gerrit]: https://www.mediawiki.org/wiki/Gerrit diff --git a/README.txt b/README.txt deleted file mode 100644 index cc54c24..0000000 --- a/README.txt +++ /dev/null @@ -1,11 +0,0 @@ -VisualEditor provides a visual editor for wiki pages. It is written in -JavaScript and runs in a web browser. - -It uses the Parsoid parser to convert wikitext documents to annotated HTML -which the VisualEditor is able to load, modify and emit back to Parsoid at -which point it is converted back into wikitext. - -For more information about these projects, check out the wiki: - - * http://www.mediawiki.org/wiki/VisualEditor - * http://www.mediawiki.org/wiki/Parsoid -- To view, visit https://gerrit.wikimedia.org/r/80333 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I8e26fea108c32f37078e363f1af18eaf28b83516 Gerrit-PatchSet: 2 Gerrit-Project: mediawiki/extensions/VisualEditor Gerrit-Branch: master Gerrit-Owner: Cscott <[email protected]> Gerrit-Reviewer: Catrope <[email protected]> Gerrit-Reviewer: jenkins-bot _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
