Skip to content

Commit 0c2b720

Browse files
committed
docs: Create dedicated CONTRIBUTING.md
Create a dedicated file for explaining how to install and test the project. (I had forgotten a few steps, so recording what I re-learned to save myself and others time in the future).
1 parent be40ebb commit 0c2b720

File tree

2 files changed

+36
-13
lines changed

2 files changed

+36
-13
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
## Environment Setup
4+
5+
**Install Java**
6+
7+
For these instructions we'll use SDKman! to manage the installation
8+
9+
```bash
10+
sudo apt install zip unzip
11+
curl -s "https://get.sdkman.io" | bash
12+
```
13+
14+
Install Java 11
15+
16+
```bash
17+
sdk install 11.0.25-tem
18+
```
19+
20+
Check installation
21+
```
22+
java -version
23+
```
24+
25+
## Build
26+
TNoodle CLI uses Gradle, so building from source is just the standard gradle build command.
27+
```
28+
./gradlew build
29+
```
30+
The built .jar file will be located at `./build/releases/tnoodle-cli-VERSION.jar`
31+
32+
If you want to build the full distributions for each operating system, then use the `runtimeZip` task.
33+
```
34+
./gradlew runtimeZip
35+
```
36+
The built distributions will be in `./build/releases/`

README.md

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,6 @@ L' F B2 L F2 B2 L' F2 L2 R B2 U' B' D' L2 D' F2 B2 R2 Fw2 U Rw2 Uw2 R' U' Rw2 R
6868
```
6969
![Image of a WCA 3x3 Scramble](docs/resources/images/three.svg)
7070

71-
## Build
72-
TNoodle CLI uses Gradle, so building from source is just the standard gradle build command.
73-
```
74-
./gradlew build
75-
```
76-
The built .jar file will be located at `./build/releases/tnoodle-cli-VERSION.jar`
77-
78-
If you want to build the full distributions for each operating system, then use the `runtimeZip` task.
79-
```
80-
./gradlew runtimeZip
81-
```
82-
The built distributions will be in `./build/releases/`
83-
8471
## Legal
8572
***Disclaimer:** This CLI tool is an **unofficial** project currently unaffiliated with the WCA. Scrambles generated by this tool are NOT authorized for use in any official WCA event. All such scrambles must be generated using the [official TNoodle program](https://www.worldcubeassociation.org/regulations/scrambles/).*
8673

0 commit comments

Comments
 (0)