Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sunny-chung committed Apr 27, 2024
1 parent c4d3f0a commit edcad44
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ _A lite embedded Kotlin interpreter_
![tvOS](https://img.shields.io/badge/tvOS-blue)
![Verification Test Status](https://github.com/sunny-chung/kotlite/actions/workflows/run-test.yaml/badge.svg?branch=main)

**Kotlite** is an open-sourced type-safe programming language that has a rich subset of the [Kotlin](https://kotlinlang.org/) script language. It comes with standard libraries, which are a subset of Kotlin Multiplatform/Common standard libraries and a few third-party libraries.
**Kotlite** is an open-sourced type-safe programming language that has a rich subset of the [script](https://kotlinlang.org/docs/custom-script-deps-tutorial.html) variant of the [Kotlin](https://kotlinlang.org/) programming language. It comes with standard libraries, which are a subset of Kotlin Multiplatform/Common standard libraries and a few third-party libraries.

**Kotlite Interpreter** is a lightweight Kotlin Multiplatform library to interpret and execute codes written in Kotlite, and bridge the host runtime environment and the embedded runtime environment.

Expand All @@ -21,6 +21,8 @@ Kotlite Stdlib ![Kotlite Stdlib](https://img.shields.io/maven-central/v/io.githu

Kotlite Library Preprocessor ![Kotlite Library Preprocessor](https://img.shields.io/maven-central/v/io.github.sunny-chung/kotlite-stdlib-processor-plugin)

[Release Notes](CHANGELOG.md)

## TL;DR

```kotlin
Expand Down
2 changes: 1 addition & 1 deletion doc/usermanual/Introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Introduction

*Kotlite* is an open-sourced type-safe programming language that has a rich subset of the https://kotlinlang.org/[Kotlin] script language. It comes with standard libraries, which are a subset of Kotlin Multiplatform/Common standard libraries and a few third-party libraries.
*Kotlite* is an open-sourced type-safe programming language that has a rich subset of the https://kotlinlang.org/docs/custom-script-deps-tutorial.html[script] variant of the https://kotlinlang.org/[Kotlin] programming language. It comes with standard libraries, which are a subset of Kotlin Multiplatform/Common standard libraries and a few third-party libraries.

*Kotlite Interpreter* is a lightweight Kotlin Multiplatform library to interpret and execute codes written in Kotlite, and bridge the host runtime environment and the embedded runtime environment.

Expand Down
5 changes: 5 additions & 0 deletions doc/usermanual/Release Notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= Release Notes

* https://github.com/sunny-chung/kotlite/blob/main/interpreter/CHANGELOG.md[Interpreter]
* https://github.com/sunny-chung/kotlite/blob/main/stdlib/CHANGELOG.md[Standard Libraries]
* https://github.com/sunny-chung/kotlite/blob/main/stdlib-processor-gradle-plugin/CHANGELOG.md[Library Preprocessor Plugin]
2 changes: 2 additions & 0 deletions doc/usermanual/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ include::Introduction.adoc[]

include::Demo.adoc[]

include::Release Notes.adoc[]

include::Feature Requests or Reporting Issues.adoc[]

= The Kotlite Interpreter
Expand Down
Binary file modified doc/usermanual/media/Web.mp4
Binary file not shown.

0 comments on commit edcad44

Please sign in to comment.