Rfaulk has uploaded a new change for review. https://gerrit.wikimedia.org/r/64514
Change subject: add. usage details to readme. ...................................................................... add. usage details to readme. Change-Id: Ibf099c727a5ac32ecc3cad39ed3edd5d5c81548b --- M README.rst 1 file changed, 27 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/sartoris refs/changes/14/64514/1 diff --git a/README.rst b/README.rst index 05bd0cd..1a0a1ec 100644 --- a/README.rst +++ b/README.rst @@ -19,3 +19,30 @@ - Genre: Novel Source: http://en.wikipedia.org/wiki/Sartoris + +Usage +----- + +First set the "hook-dir" and "tag-prefix" for the deploy section in your global .gitconfig: + + git config --global deploy.hook-dir .git/deploy/hooks + git config --global deploy.tag-prefix {%project name%} + +Next create the sartoris configuration file by first copying ./sartoris/config.py.example to +./sartoris/config.py then setting the TEST_REPO and SARTORIS_HOME variables. The TEST_REPO +should be defined in your /tmp folder while SARTORIS_HOME should point to the your local +Sartoris project home. + +To start a new deployment issue a 'start' command: + + python {% SARTORIS_HOME %}/sartoris/sartoris.py start + +At this point you are free to make commits to the project and when ready for deployment issue +a 'sync' command: + + python {% SARTORIS_HOME %}/sartoris/sartoris.py sync + +The process may be aborted at any point with an 'abort' command: + + python {% SARTORIS_HOME %}/sartoris/sartoris.py abort + -- To view, visit https://gerrit.wikimedia.org/r/64514 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ibf099c727a5ac32ecc3cad39ed3edd5d5c81548b Gerrit-PatchSet: 1 Gerrit-Project: sartoris Gerrit-Branch: master Gerrit-Owner: Rfaulk <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
