Skip to content

Commit 7c85648

Browse files
committed
Add contributing instructions, remove build script
1 parent b59008e commit 7c85648

File tree

2 files changed

+61
-17
lines changed

2 files changed

+61
-17
lines changed

CONTRIBUTING.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
Development And Contributing Instructions
2+
=========================================
3+
4+
Making a new release
5+
--------------------
6+
7+
To create a new release, clone the [scijava-scripts][gh_scijava-scripts] repo
8+
(e.g. in `/opt/imagej/`) and run the `release-version.sh` helper:
9+
10+
```bash
11+
BASE_DIR=/opt/imagej
12+
mkdir -pv "$BASE_DIR"
13+
cd "$BASE_DIR"
14+
git clone https://github.com/scijava/scijava-scripts
15+
cd -
16+
17+
"$BASE_DIR/scijava-scripts/release-version.sh"
18+
```
19+
20+
Build & Deploy using Visual Studio Code
21+
---------------------------------------
22+
23+
Building and deploying the package can be greatly simplified using "tasks" in
24+
[Visual Studio Code][www_vscode]. By adding the following settings to the
25+
`.vscode/tasks.json` file, you can simply press `Ctrl+Shift+B` in VS Code and
26+
select the *deploy* task for running Maven and have the resulting JAR file being
27+
placed in `/opt/fiji-packaging/Fiji.app/jars/` (adjust to your path as
28+
necessary):
29+
30+
```json
31+
{
32+
"version": "2.0.0",
33+
"tasks": [
34+
{
35+
"label": "verify",
36+
"type": "shell",
37+
"command": "mvn -B verify",
38+
"group": "build"
39+
},
40+
{
41+
"label": "test",
42+
"type": "shell",
43+
"command": "mvn -B test",
44+
"group": "test"
45+
},
46+
{
47+
"label": "deploy",
48+
"type": "shell",
49+
"command": "mvn -Dimagej.app.directory=/opt/fiji-packaging/Fiji.app",
50+
"group": {
51+
"kind": "build",
52+
"isDefault": true
53+
},
54+
"problemMatcher": []
55+
}
56+
]
57+
}
58+
```
59+
60+
[gh_scijava-scripts]: https://github.com/scijava/scijava-scripts
61+
[www_vscode]: https://code.visualstudio.com/

scripts/build_and_deploy.sh

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)