Skip to content

Commit 7505e36

Browse files
authored
update readme to not suggest using make anymore (#242)
1 parent 476087b commit 7505e36

File tree

1 file changed

+9
-16
lines changed

1 file changed

+9
-16
lines changed

README.md

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -62,30 +62,23 @@ The extract tool may become able to generate legacy compatible sources, which wo
6262

6363
## Development and Testing
6464

65-
This project contains quite a few builds, Swift, Java, and depends on some custom steps.
65+
This project contains multiple builds, living sid3e by side together.
6666

67-
Easiest way to get going is to:
67+
Depending on which part you are developing, you may want to run just the swift tests:
6868

6969
```bash
70-
make javakit-run # Run the JavaKit example of Swift code using Java libraries
71-
make jextract-run # Run the jextract-swift example of Java code using Swift libraries
72-
swift test # test all Swift code, e.g. jextract-swift
73-
./gradlew test # test all Java code, including integration tests that actually use jextract-ed sources
70+
> swift test
7471
```
7572

76-
To test on Linux using Docker you can:
73+
or the Java tests through the Gradle build. The Gradle build may also trigger some Swift compilation because of
74+
interlinked dependencies of the two parts of Swift-Java. To run the Java build and tests use the Gradle wrapper script:
7775

78-
```bash
79-
# run only Swift tests (i.e. swift test)
80-
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test-swift
81-
82-
# run only Java tests (i.e. gradle test)
83-
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test-java
84-
85-
# run all tests
86-
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test
76+
```bash
77+
> ./gradlew test
8778
```
8879

80+
Currently it is suggested to use Swift 6.0 and a Java 24+.
81+
8982
### Sample Apps
9083

9184
Sample apps are located in the `Samples/` directory, and they showcase full "roundtrip" usage of the library and/or tools.

0 commit comments

Comments
 (0)