diff --git a/README.md b/README.md index 2db3934..8e8f429 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,51 @@ ## Requirements -The Source Integration framework requires Mantis version 1.2.0 or -higher. +The Source Integration framework requires [Mantis](http://www.mantisbt.org/) +version 1.2.0 or higher. ## Installation -For basic instruction on getting started with the plugin framework, -see the article on LeetCode.net covering Git and Subversion: - http://leetcode.net/blog/2009/01/integrating-git-svn-with-mantisbt/ +1. Download or clone a copy of the [Source Integration source + code](http://github.com/mantisbt-plugins/source-integration/). + +2. Copy the primary Source plugin (the `Source/` directory) into your Mantis + installation's `plugins/` directory. + +3. Copy all the remaining plugins, or just the appropriate ones for your + repositories, into your Mantis installation's `plugins/` directory. + +4. While logged into your Mantis installation as an administrator, go to + 'Manage' -> "Manage Plugins". + +5. In the "Available Plugins" list, you'll find the "Source Control + Integration" and additional plugins: + + a. First, click the "Install" link for the "Source Control Integration" + plugin. + + b. Next, click the "Install" link next to any additional Source Control + plugins appropriate for your repositories. + +6. Click on the "Source Control Integration" plugin to configure it. + +7. Go to "Repositories" and enter your repository name, select the + repository type, and click "Create Repository" to begin adding your first + repository. + +8. Once configured, click the "Return to Repository" link and click either + the "Import Everything" or "Import Newest Data" button to perform initial + import of repository changesets and verify configuration. + +9. Once satisfied that your repository is configured & working correctly, + you can automate the import of new changesets by configuring a cron + job on the web server where your Mantis installation resides, as follows: + + curl "http://host.domain.tld/mantisbt/plugin.php?page=Source/import&id=all" + + This will import new changesets for all configured repositories. + +10. Add additional repositories as needed. ## Support