Skip to content

[readme] update readme to not suggest using make #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged

[readme] update readme to not suggest using make #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 9 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,30 +62,23 @@ The extract tool may become able to generate legacy compatible sources, which wo

## Development and Testing

This project contains quite a few builds, Swift, Java, and depends on some custom steps.
This project contains multiple builds, living sid3e by side together.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo of side

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, followign up


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

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

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

```bash
# run only Swift tests (i.e. swift test)
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test-swift

# run only Java tests (i.e. gradle test)
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test-java

# run all tests
docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2204.main.yaml run test
```bash
> ./gradlew test
```

Currently it is suggested to use Swift 6.0 and a Java 24+.

### Sample Apps

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