Skip to content

Commit

Permalink
Updated documentation pages with ILI9341 demo.
Browse files Browse the repository at this point in the history
  • Loading branch information
nthnn committed Mar 9, 2024
1 parent d5ba46b commit a219fc3
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@
</div>
<div class="textblock"><div align="center"> <img src="rishka-logo.png" alt="" width="140" class="inline"/> </div><p><img src="https://github.com/nthnn/rishka/actions/workflows/arduino_ci.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/rishka/actions/workflows/arduino_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/rishka/actions/workflows/rust_ci.yml/badge.svg" alt="Rust Build CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/rishka/actions/workflows/sdk_ci.yml/badge.svg" alt="SDK Build CI" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/github/repo-size/nthnn/rishka?logo=git&amp;label=Repository%20Size" alt="GitHub repo size" class="inline"/></p>
<p>Rishka is a RISC-V virtual runtime in C/C++ made for ESP32-WROVER with PSRAM specifically developed as kernel for <a href="https://github.com/nthnn/Jessy-OS">Jessy OS</a>.</p>
<h2><a class="anchor" id="autotoc_md0"></a>
<div align="center"> <img src="rishka-ili9341.gif" alt="" class="inline"/> <br />
<br />
<em>Rishka running shell example with an ILI9341 TFT LCD and FabGL.</em> </div><h2><a class="anchor" id="autotoc_md0"></a>
How Does It Work?</h2>
<p>The Rishka virtual runtime is a system designed to run special RISC-V binaries smoothly on ESP32-WROVER microcontroller units. Under the hood, the virtual machine serves as the main engine, while the kernel acts as its core component. The kernel handles system calls efficiently, providing a range of interfaces for accessing different system features and services.</p>
<div align="center"> <img src="rishka-flow.png" alt="" class="inline"/> </div><p>These include basic functions like managing files, as well as more complex tasks like controlling GPIO pins, attaching and detaching interrupts, and communication protocols such as <a class="el" href="d4/d47/class_i2_c.html" title="Class for handling I2C operations in Rishka applications.">I2C</a> and <a class="el" href="d3/dfe/class_s_p_i.html" title="Class for handling SPI communication in Rishka applications.">SPI</a>. Additionally, the kernel manages system utilities specific to the Jessy OS, handling tasks like sub-process runtime and memory allocation.</p>
Expand Down Expand Up @@ -146,7 +148,7 @@ <h4><a class="anchor" id="autotoc_md4"></a>
<div class="fragment"><div class="line">export RISHKA_LIBPATH=/Arduino/libraries/rishka/sdk</div>
<div class="line">export RISHKA_SCRIPTS=/Arduino/libraries/rishka/scripts</div>
</div><!-- fragment --><p>If no problems occured and was configured as instructed, you can now seamlessly use the <code>rishka-cc</code>.</p>
<p><img src="assets/rishka-cc.png" alt="" width="90%" class="inline"/> </p>
<p><img src="rishka-cc.png" alt="" width="90%" class="inline"/> </p>
<h4><a class="anchor" id="autotoc_md5"></a>
Manually Compiling</h4>
<p>To compile SDK examples provided with Rishka, follow these steps:</p>
Expand Down

0 comments on commit a219fc3

Please sign in to comment.