diff --git a/README.md b/README.md index 739b7c9..e0eac60 100644 --- a/README.md +++ b/README.md @@ -9,40 +9,40 @@ sort of Version Control System (VCS) with Mantis, including support for multiple repositories, changesets or revisions, and file path tracking. It has many features already, such as importing repository history and -optional support for remote check-ins or imports, and utilizes a +optional support for remote check-ins or imports, and utilizes a class-based API to access objects in the database. -Initial support is included for [Subversion](http://subversion.apache.org/) -and [Git](http://git-scm.com/) repositories using the following extension +Initial support is included for [Subversion](http://subversion.apache.org/) +and [Git](http://git-scm.com/) repositories using the following extension plugins: -* **SourceCgit**: Git repositories accessible via a +* **SourceCgit**: Git repositories accessible via a [cgit](http://hjemli.net/git/cgit/) web frontend installation. * **SourceGithub**: Git repositories hosted on [GitHub](http://github.com/). -* **SourceGitWeb**: Git repositories accessible via a - [GitWeb](https://git.wiki.kernel.org/index.php/Gitweb) web frontend +* **SourceGitweb**: Git repositories accessible via a + [GitWeb](https://git.wiki.kernel.org/index.php/Gitweb) web frontend installation. -* **SourceSFSVN**: SVN repositories hosted on +* **SourceHgWeb**: Mercurial repositories accessible via a + [HgWeb](http://mercurial.selenic.com/wiki/PublishingRepositories#hgweb) + frontend installation. +* **SourceSFSVN**: SVN repositories hosted on [SourceForge](http://sourceforge.net/). * **SourceSVN**: SVN repositories locally accessible by the SVN binaries. -* **SourceWebSVN**: SVN repositories accessible via a +* **SourceWebSVN**: SVN repositories accessible via a [WebSVN](http://www.websvn.info/) web frontend installation. -Support for more source control tools is planned and should be rather +Support for more source control tools should be rather straightforward to implement due to the flexibility inherent in the integration framework and API. ## Requirements -The Source Integration framework requires [Mantis](http://www.mantisbt.org/) +The Source Integration framework requires [Mantis](http://www.mantisbt.org/) version 1.2.0 or higher. -**NOTE:** As of this writing the **SourceGithub** plugin requires either Mantis -1.2.16 (not yet released) or Mantis 1.2.15 with the -[mantisbt/mantisbt@8df9d5f](http://github.com/mantisbt/mantisbt/commit/8df9d5fa221bb85f9f8c1ca6b698d75b740d6449) -patch applied. This is due to a new requirement in GitHub API v3 ([User Agent header is -mandatory for all API -requests](http://developer.github.com/changes/2013-04-24-user-agent-required/)) +The **SourceGithub** plugin requires Mantis 1.2.16. +This is due to a new requirement in GitHub API v3 +([User Agent header is mandatory for all API requests](http://developer.github.com/changes/2013-04-24-user-agent-required/)) enforced as of 2013-04-24. ## Installation @@ -50,7 +50,7 @@ 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 +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 @@ -61,10 +61,10 @@ 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. @@ -75,15 +75,15 @@ repository. 8. Once configured, click the "Return to Repository" link and click either - the "Import Everything" or "Import Newest Data" button to perform initial + 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. @@ -106,4 +106,4 @@ Original project and documentation can be found on noswap.com: - http://noswap.com/projects/source-integration/ \ No newline at end of file + http://noswap.com/projects/source-integration/