Skip to content

Commit 2457561

Browse files
author
Jegors Cemisovs
committed
Update documentation for Mise setup and running demos
1 parent 6cbc49f commit 2457561

2 files changed

Lines changed: 47 additions & 5 deletions

File tree

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,43 @@ There are implementations and tests for two algorithms:
1212
The implementation is written in Java 17. [API documentation](https://algorithms.jc.id.lv/docs/api/) is available. You
1313
can also see the [specifications](https://algorithms.jc.id.lv/docs/spock-reports/) generated with the spock-reports.
1414

15+
## Development Setup with Mise
16+
17+
This project uses [mise](https://mise.jdx.dev/) to manage its toolchain (Java 17 and Gradle 7.5.1) and run development tasks.
18+
19+
To set up the development environment:
20+
21+
1. Install `mise` if you haven't already.
22+
2. Trust the project configuration:
23+
```shell
24+
mise trust
25+
```
26+
3. Install the required tools (Java and Gradle):
27+
```shell
28+
mise install
29+
```
30+
31+
### Available Tasks
32+
33+
You can run various tasks defined in `mise.toml`:
34+
35+
* **Build and Test**: Run the test suite and build the project:
36+
```shell
37+
mise run build
38+
```
39+
* **Run Java Demo**: Launch the Java application demo:
40+
```shell
41+
mise run demo-java
42+
```
43+
* **Run Groovy Demo**: Launch the Groovy script demo:
44+
```shell
45+
mise run demo-groovy
46+
```
47+
* **Run Graph Shell**: Launch the interactive console shell:
48+
```shell
49+
mise run demo-shell
50+
```
51+
1552
## Demo. Graph Shell
1653

1754
To demonstrate the work of search algorithms, I made a small console program '[Graph Shell](graph-shell/README.md)'. The program

graph-shell/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,25 @@ To demonstrate the work of search algorithms, I made a small console program. Th
88

99
## Build & Run
1010

11-
To compile the program, use the command:
11+
You can build and run this program easily using **mise**:
1212

1313
```shell
14-
$ gradle assemble
14+
$ mise run demo-shell
1515
```
1616

17-
This command will create an executable jar, so in Linux or macOS you may run the application by
17+
Alternatively, you can compile and run using Gradle manually (using the tool chain managed by `mise` or system tools):
1818

19+
To compile:
1920
```shell
20-
$ ./build/libs/graph-shell-1.0-SNAPSHOT.jar
21+
$ gradle assemble
2122
```
2223

23-
On the Windows machine you should run the application using java:
24+
This command will create an executable jar. On Linux or macOS you can run it via:
25+
```shell
26+
$ ./build/libs/graph-shell-1.0-SNAPSHOT.jar
27+
```
2428

29+
On a Windows machine you should run the application using java:
2530
```shell
2631
$ java -jar ./build/libs/graph-shell-1.0-SNAPSHOT.jar
2732
```

0 commit comments

Comments
 (0)