Arlolra has uploaded a new change for review. https://gerrit.wikimedia.org/r/172310
Change subject: Switch readme to markdown ...................................................................... Switch readme to markdown * And add the travis build status. Change-Id: I283f9a4745fb39df746cd4be63d264a9c122f6e5 --- A README.md D README.txt 2 files changed, 37 insertions(+), 24 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/services/parsoid refs/changes/10/172310/1 diff --git a/README.md b/README.md new file mode 100644 index 0000000..d63ba3c --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +Parsoid +======= + +[](https://travis-ci.org/wikimedia/parsoid) + +A combined Mediawiki and html parser in JavaScript running on node.js. Please +see (https://www.mediawiki.org/wiki/Future/Parser_development) for an overview +of the current implementation, and instructions on running the tests. + +You might need to set the NODE_PATH environment variable, +```shell +export NODE_PATH="node_modules" +``` + +Download the dependencies: +```shell +npm install +``` + +Run tests: +```shell +npm test +``` + +Configure your Parsoid web service: +```shell +cd api +cp localsettings.js.example localsettings.js +// Tweak localsettings.js +``` + +Run the webservice: +```shell + npm start +``` + +More details are available at https://www.mediawiki.org/wiki/Parsoid/Setup diff --git a/README.txt b/README.txt deleted file mode 100644 index 00bca56..0000000 --- a/README.txt +++ /dev/null @@ -1,24 +0,0 @@ -A combined Mediawiki and html parser in JavaScript running on node.js. Please -see (https://www.mediawiki.org/wiki/Future/Parser_development) for an overview -of the current implementation, and instructions on running the tests. - -You might need to set the NODE_PATH environment variable, - export NODE_PATH="node_modules" - -Download the dependencies: - npm install - -Run tests: - npm test - -Configure your Parsoid web service: - - cd api - cp localsettings.js.example localsettings.js - // Tweak localsettings.js - -Run the webservice: - - npm start - -More details are available at https://www.mediawiki.org/wiki/Parsoid/Setup -- To view, visit https://gerrit.wikimedia.org/r/172310 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I283f9a4745fb39df746cd4be63d264a9c122f6e5 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/services/parsoid Gerrit-Branch: master Gerrit-Owner: Arlolra <abrea...@wikimedia.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
