Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ title: Installation
---
# Installation

Endive requires **Java 11** or later.

Add Endive to your project using Maven or Gradle.

[![Maven Central](https://img.shields.io/maven-central/v/run.endive/runtime)](https://central.sonatype.com/artifact/run.endive/runtime)

## Maven

Add the runtime dependency to your `pom.xml`:
Expand Down
10 changes: 10 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,14 @@ sidebar_label: Quick Start
title: Quick start
---

:::info[Requirements]
Endive requires **Java 11** or later. SIMD support requires Java 21+.
:::

### Install the dependency

[![Maven Central](https://img.shields.io/maven-central/v/run.endive/runtime)](https://central.sonatype.com/artifact/run.endive/runtime)

To use the runtime, you need to add the `run.endive:runtime` dependency
to your dependency management system.

Expand Down Expand Up @@ -64,6 +70,10 @@ var module = Parser.parse(new File("./factorial.wasm"));
Instance instance = Instance.builder(module).build();
```

:::note[Threading]
`Instance` and `Store` are not thread-safe. Create separate instances per thread, or synchronize access externally. Memory operations (used by the Wasm threads proposal) are thread-safe.
:::

You can think of the `module` as of inert code, and the `instance`
is the run-time representation of that code: a virtual machine ready to execute.

Expand Down
7 changes: 6 additions & 1 deletion docs/scripts/generate-llm-files.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,14 @@ function generateLlmsFullTxt(docEntries, blogEntries) {
sections.push(cleanContent(entry.content));
}

if (blogEntries.length > 0) {
sections.push('---', '', '# Blog Posts', '',
'> The following are blog posts, not reference documentation.', '');
}

for (const entry of blogEntries) {
sections.push('---', '');
sections.push(`## Blog: ${entry.title}`);
sections.push(`## ${entry.title}`);
sections.push('');
sections.push(cleanContent(entry.content));
}
Expand Down
Loading