Samples: add readme file

This commit is contained in:
Alexey Andreev 2023-03-19 19:27:41 +01:00
parent 073a444cc9
commit c9d97b7144
2 changed files with 10 additions and 0 deletions

View File

@ -20,6 +20,7 @@ Useful links:
Simply clone source code (`git clone https://github.com/konsoletyper/teavm.git`) Simply clone source code (`git clone https://github.com/konsoletyper/teavm.git`)
and run Gradle build (`./gradlew publishToMavenLocal` or `gradlew.bat publishToMavenLocal`). and run Gradle build (`./gradlew publishToMavenLocal` or `gradlew.bat publishToMavenLocal`).
You should build samples separately, as described in [corresponding readme file](samples/README.md).
### Useful Gradle tasks ### Useful Gradle tasks

9
samples/README.md Normal file
View File

@ -0,0 +1,9 @@
To build these samples, you should do one of:
* Publish TeaVM into local repository as described in [main readme](../README.md) (preferred way).
* Take `build.gradle.kts` and update TeaVM version to the most recent version, published in Maven Central.
Please, refer to [main readme](../README.md) for a badge with recent version number.
To quickly tests built war file, you can run `./gradlew :<example-name>:appRunWar` or
`gradlew bat :<example-name>:appRunWar`.
Note that some examples also provide WASI and native binaries, please refer to corresponding build files.