Marina Konstantinova 4 年之前
父節點
當前提交
3c7e453435

File diff suppressed because it is too large
+ 165 - 0
docs/docs/01-u-overview.md


+ 21 - 0
docs/docs/02-u-download-install.md

@@ -0,0 +1,21 @@
+---
+id: 02-u-download-install
+title: Download and install
+sidebar_label: Download and install
+---
+
+In order to get the tool working, [dowload the archive](https://github.com/metrixplusplus/metrixplusplus/releases) with the latest stable version and unpack it to some folder. The first run of the tool will trigger the installation within the folder, where it was launched.
+
+In order to checkout the latest development version from the [version control system](https://github.com/metrixplusplus/metrixplusplus) use this command:
+```sh
+> git clone https://github.com/metrixplusplus/metrixplusplus metrixplusplus
+```
+
+#### Change and Release Notes
+Change and release notes are available [here](https://github.com/metrixplusplus/metrixplusplus/blob/master/CHANGELOG.md).
+
+#### Prerequisites
+Python Runtime Environment (version 2.8.x or 3.x)
+
+#### License
+[MIT license](https://github.com/metrixplusplus/metrixplusplus/blob/master/LICENSE)

+ 26 - 0
docs/docs/03-u-getting-started.md

@@ -0,0 +1,26 @@
+---
+id: 03-u-getting-started
+title: Getting started
+sidebar_label: Getting started
+---
+
+The tool is relatively simple to use. There are 3 fundamental steps:
+
+* Collect the data, for example:
+```bash
+> python "/path/to/metrix++.py" collect --std.code.lines.code --std.code.complexity.cyclomatic
+```
+
+
+* View the data, for example:
+```bash
+> python "/path/to/metrix++.py" view
+```
+
+
+* Apply thresholds, for example:
+```bash
+> python "/path/to/metrix++.py" limit --max-limit=std.code.complexity:cyclomatic:7
+```
+
+Please, check the advanced [description of the workflow](04-u-workflow.md) with real examples.

File diff suppressed because it is too large
+ 506 - 0
docs/docs/04-u-workflow.md


File diff suppressed because it is too large
+ 642 - 0
docs/docs/05-u-extending-tool.md


+ 16 - 0
docs/docs/06-u-feeback-contribute.md

@@ -0,0 +1,16 @@
+---
+id: 06-u-feeback-contribute
+title: Feeback and contribute
+sidebar_label: Feeback and contribute
+---
+Now it is your turn. There are multiple ways how you can contribute and help to improve and progress Metrix++ project:
+
+* Try Metrix++ and [post review](https://github.com/metrixplusplus/metrixplusplus/issues/new)
+* [Submit new feature request or bug report](https://github.com/metrixplusplus/metrixplusplus/issues/new)
+* [Ask a question](https://github.com/metrixplusplus/metrixplusplus/issues/new)
+* Submit git pull request
+* Create and publish your plugin. [Request to refer](https://github.com/metrixplusplus/metrixplusplus/issues/new) to it from Metrix++ project space.
+* [Submit your plugin](https://github.com/metrixplusplus/metrixplusplus/issues/new) to include to the standard set
+* ... and consider to 
+<a href="mailto:avkonst@gmail.com?subject=Metrix%2B%2B Join Request" target="blank">join the project</a>
+!