From c9d97b7144a4689d0044a1f07193c6a8e01aa7db Mon Sep 17 00:00:00 2001 From: Alexey Andreev Date: Sun, 19 Mar 2023 19:27:41 +0100 Subject: [PATCH] Samples: add readme file --- README.md | 1 + samples/README.md | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 samples/README.md diff --git a/README.md b/README.md index f676cab4d..177c7a5b5 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Useful links: Simply clone source code (`git clone https://github.com/konsoletyper/teavm.git`) 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 diff --git a/samples/README.md b/samples/README.md new file mode 100644 index 000000000..8ed771dd9 --- /dev/null +++ b/samples/README.md @@ -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 ::appRunWar` or +`gradlew bat ::appRunWar`. +Note that some examples also provide WASI and native binaries, please refer to corresponding build files. \ No newline at end of file