avkonst 11 years ago
parent
commit
a7ecd101ea
1 changed files with 43 additions and 0 deletions
  1. 43 0
      README.md

+ 43 - 0
README.md

@@ -0,0 +1,43 @@
+# [Metrix++](http://metrixplusplus.sourceforge.net)
+
+Metrix++ is an extendable tool for code metrics collection and analysis.
+Check projects documentation for additional information:
+
+* [http://metrixplusplus.sourceforge.net](http://metrixplusplus.sourceforge.net)
+* ./doc folder within the distributive
+
+Thank you for using the tool!
+
+
+
+## Versioning
+
+Releases are numbered with the following format:
+
+`<major>.<minor>.<revision>`
+
+And constructed with the following guidelines:
+
+* Major is stepped up and minor is reset in case of release with non-backward compatible changes in the API
+* Minor is stepped up at any release
+* Revision corresponds to mainline branch revision number in the svn, never reset
+
+
+
+## Issue tracker and feedback 
+
+Have a bug or a feature request or any feedback?
+[Please submit a ticket](https://sourceforge.net/p/metrixplusplus/tickets/new/) or
+[email to project administrator](mailto:mailto:avkonst@users.sourceforge.net).
+
+
+
+## Copyright and license
+
+Copyright 2009-2013 Metrix++ Project.
+
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 3 of the License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with the Metrix++; if not, contact [Project Administrator](mailto:mailto:avkonst@users.sourceforge.net)