You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,10 @@
9
9
10
10
Provides SCM-Manager metrics as json.
11
11
12
+
## Usage
13
+
14
+
Find out how this plugin can be used on the [user documentation page](https://scm-manager.org/plugins/scm-metrics-json-plugin/docs).
15
+
12
16
## Build and testing
13
17
14
18
The plugin can be compiled and packaged with the normal maven lifecycle:
@@ -30,7 +34,7 @@ If the plugin was started with `gradle run`, the default browser of the os shoul
30
34
If the browser does not start automatically, start it manually and go to [http://localhost:8081/scm](http://localhost:8081/scm).
31
35
32
36
In this mode each change to web files (src/main/js or src/main/webapp), should trigger reload of the browser with the made changes.
33
-
If you compile a class (e.g.: with your IDE from src/main/java to target/classes),
37
+
If you compile a class (e.g.: with your IDE from src/main/java to target/classes),
34
38
the SCM-Manager context will restart automatically. So you can see your changes without restarting the server.
35
39
36
40
## Directory & File structure
@@ -54,7 +58,7 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
54
58
├── CHANGELOG.md
55
59
├── gradle.properties
56
60
├── gradlew
57
-
├── LICENSE
61
+
├── LICENSE.txt
58
62
├── package.json
59
63
├── README.md
60
64
├── settings.gradle
@@ -64,15 +68,15 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
64
68
1.**`node_modules/`**: This directory contains all modules of code that your project depends on (npm packages) are automatically installed.
65
69
66
70
2.**`src/`**: This directory will contain all code related to what you see or not. `src` is a convention for “source code”.
67
-
1.**`main/`**
68
-
1.**`java/`**: This directory contains the Java code.
69
-
2.**`js/`**: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with `.test.ts`
70
-
3.**`resources/`**: This directory contains the classpath resources.
71
-
2.**`test/`**
72
-
1.**`java/`**: This directory contains the Java unit tests.
73
-
3.**`resources/`**: This directory contains classpath resources for unit tests.
74
-
3.**`target/`**: This is the build directory.
75
-
71
+
1.**`main/`**
72
+
1.**`java/`**: This directory contains the Java code.
73
+
2.**`js/`**: This directory contains the JavaScript code for the web ui, inclusive unit tests: suffixed with `.test.ts`
74
+
3.**`resources/`**: This directory contains the classpath resources.
75
+
2.**`test/`**
76
+
1.**`java/`**: This directory contains the Java unit tests.
77
+
3.**`resources/`**: This directory contains classpath resources for unit tests.
78
+
3.**`target/`**: This is the build directory.
79
+
76
80
3.**`.editorconfig`**: This is a configuration file for your editor using [EditorConfig](https://editorconfig.org/). The file specifies a style that IDEs use for code.
77
81
78
82
4.**`.gitignore`**: This file tells git which files it should not track / not maintain a version history for.
@@ -85,12 +89,12 @@ A quick look at the files and directories you'll see in a SCM-Manager project.
85
89
86
90
8.**`gradlew`**: Bundled gradle wrapper if you don`t have gradle installed.
87
91
88
-
9.**`LICENSE`**: This project is licensed under the MIT license.
92
+
9.**`LICENSE.txt`**: This project is licensed under the MIT license.
89
93
90
94
10.**`package.json`**: Here you can find the dependency/build configuration and dependencies for the frontend.
91
95
92
96
11.**`README.md`**: This file, containing useful reference information about the project.
0 commit comments