Skip to content

Commit e062a79

Browse files
committed
Update README file
1 parent cc7ed0c commit e062a79

File tree

1 file changed

+41
-29
lines changed

1 file changed

+41
-29
lines changed

README.md

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Mantis Source Integration
22

33
Copyright (c) 2008 - 2012 John Reese - http://noswap.com
4-
Copyright (c) 2012 - 2014 MantisBT Team - [email protected]
4+
Copyright (c) 2012 - 2017 MantisBT Team - [email protected]
55

66
Released under the [MIT license](http://opensource.org/licenses/MIT)
77

@@ -24,6 +24,8 @@ plugins:
2424
[cgit](http://hjemli.net/git/cgit/) web frontend installation.
2525
* **SourceGithub**: Git repositories hosted on [GitHub](http://github.com/).
2626
* **SourceGitlab**: Git repositories hosted on [GitLab](https://about.gitlab.com/).
27+
* **SourceGitphp**: Git repositories accessible via a
28+
[Gitphp](https://gitphp.org/) web frontend installation.
2729
* **SourceGitweb**: Git repositories accessible via a
2830
[GitWeb](https://git.wiki.kernel.org/index.php/Gitweb) web frontend
2931
installation.
@@ -38,7 +40,7 @@ plugins:
3840
* **SourceWebSVN**: SVN repositories accessible via a
3941
[WebSVN](http://www.websvn.info/) web frontend installation.
4042

41-
Support for more source control tools should be rather
43+
Support for additional source control tools should be rather
4244
straightforward to implement due to the flexibility inherent in the
4345
integration framework and API.
4446

@@ -54,8 +56,24 @@ enforced as of 2013-04-24.
5456

5557
## Installation
5658

57-
1. Download or clone a copy of the [Source Integration source
58-
code](http://github.com/mantisbt-plugins/source-integration/).
59+
### Compatibility
60+
61+
Depending on which version of MantisBT you are using, please make sure to
62+
get the source code from the appropriate branch in the Plugin's GitHub
63+
repository, as per the table below:
64+
65+
MantisBT version | Branch | Notes
66+
:---:|---|---
67+
2.0.x | [modern-ui](https://github.com/mantisbt-plugins/source-integration/archive/modern-ui.zip) | Beta
68+
1.3.x | [master](https://github.com/mantisbt-plugins/source-integration/archive/master.zip) | **Current release**
69+
1.2.x | [master-1.2.x](https://github.com/mantisbt-plugins/source-integration/archive/master-1.2.x.zip) | Legacy
70+
71+
72+
### Setup instructions
73+
74+
1. Download the appropriate version (see [Compatibility section](#compatibility) above)
75+
or clone a copy of the [source code](https://github.com/mantisbt-plugins/source-integration/)
76+
and checkout the correct branch.
5977

6078
2. Copy the primary Source plugin (the `Source/` directory) into your Mantis
6179
installation's `plugins/` directory.
@@ -114,30 +132,24 @@ enforced as of 2013-04-24.
114132

115133
This will import new changesets for all configured repositories.
116134

117-
11. Add additional repositories as needed.
118-
119135
## Support
120136

121-
Problems or questions dealing with use and installation should be
122-
directed to the MantisBT IRC channel #mantisbt on freenode:
123-
124-
irc://freenode.net/mantisbt
125-
126-
Bug reports or fixes are highly encouraged, and should be directed to
127-
the bug tracker on GitHub:
128-
129-
http://github.com/mantisbt-plugins/source-integration/issues
130-
131-
The latest source code can be found on GitHub:
132-
133-
http://github.com/mantisbt-plugins/source-integration
134-
135-
Original project and documentation can be found on noswap.com:
136-
137-
http://noswap.com/projects/source-integration/
138-
139-
## Compatibility
140-
141-
- MantisBT 2.0.x - modern-ui branch
142-
- MantisBT 1.3.x - master-1.3.x branch
143-
- MantisBT 1.2.x - master branch
137+
The following support channels are available if you wish to file a
138+
[bug report](https://github.com/mantisbt-plugins/source-integration/issues/new),
139+
or have questions related to use and installation:
140+
141+
- [GitHub issues tracker](http://github.com/mantisbt-plugins/source-integration/issues)
142+
- [Gitter chat room](https://gitter.im/mantisbt-plugins/source-integration)
143+
- If you feel lucky you may also want to try the legacy
144+
[#mantisbt IRC channel](https://webchat.freenode.net/?channels=%23mantisbt)
145+
on Freenode (irc://freenode.net/mantisbt)
146+
but since hardly anyone goes there nowadays, you may not get any response.
147+
148+
All code contributions (bug fixes, new features and enhancements, additional
149+
VCS integration plugins) are welcome and highly encouraged, preferably as a
150+
[Pull Request](https://github.com/mantisbt-plugins/source-integration/compare).
151+
152+
The latest source code is available on
153+
[GitHub](https://github.com/mantisbt-plugins/source-integration);
154+
John Reese's original project documentation can be found on his web site,
155+
[noswap.com](http://noswap.com/projects/source-integration/).

0 commit comments

Comments
 (0)