From 9de64b8fa02aa16342149ef42e4c45e9079ebf5f Mon Sep 17 00:00:00 2001 From: Luis Obis Date: Mon, 17 Oct 2022 11:02:33 +0200 Subject: [PATCH] update usage instructions --- README.md | 18 ++++++++++++++---- public/index.html | 12 ++++++------ 2 files changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index aa96e61..b76e6c0 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,21 @@ [![build](https://github.com/lobis/fractal-explorer/actions/workflows/rust.yml/badge.svg)](https://github.com/lobis/fractal-explorer/actions/workflows/rust.yml) -A simple Julia Set explorer built using Rust. This was created as a learning project and is based on [this great tutorial](https://sotrh.github.io/learn-wgpu/). +A simple [Julia](https://en.wikipedia.org/wiki/Julia_set) and [Mandelbrot](https://en.wikipedia.org/wiki/Mandelbrot_set) Set explorer built using [Rust](https://www.rust-lang.org/). This was created as a learning project and is based on [this great tutorial](https://sotrh.github.io/learn-wgpu/). -## [Live Demo](https://lobis.github.io/fractal-explorer/) +The explorer can be run as a standalone desktop application (should work for Windows, Linux and MacOS) or as a web application for which a [demo is available](https://lobis.github.io/fractal-explorer/). -## Build +## [✨ Live Demo](https://lobis.github.io/fractal-explorer/) + +## 🤓 Usage + +* **Mouse Left Click**: Toggle Julia set *c* parameter selection. +* **Mouse Cursor Position**: Select Julia set _c_ parameter. +* **Mouse Wheel | Trackpad | Up & Down Arroy Keys**: Zoom on cursor position. +* **Mouse Right Click**: Hold and drag to translate fractal. +* **J | M Keys**: Toggle between Julia and Mandelbrot sets. + +## ⚙️ Build To build the executable run: @@ -20,4 +30,4 @@ To build the web application run the following command. You may need to install wasm-pack build --target web --out-dir public/pkg ``` -All files related to the static site will be placed under `public` with `index.html` the entrypoint. +All files related to the static site will be placed under `public` with `index.html` the entrypoint. You need to serve these files with a static http server such as [VSCode Live Server](https://marketplace.visualstudio.com/items?itemName=ritwickdey.LiveServer). diff --git a/public/index.html b/public/index.html index cf9e788..b49125a 100644 --- a/public/index.html +++ b/public/index.html @@ -52,12 +52,12 @@
× - Usage Instructions:

- Left Click: Toggle Julia set c parameter selection.
- Cursor Movement: Select c parameter.
- Mouse Wheel / Trackpad / Up & Down Arrow Keys: Zoom on cursor position
- Right Click: Hold and drag to translate fractal
- J/M Toggle between Julia and Mandelbrot
+ Usage Instructions:

+ Left Click: Toggle Julia set c parameter selection.
+ Cursor Movement: Select c parameter.
+ Mouse Wheel | Trackpad | Up & Down Arrow Keys:: Zoom on cursor position.
+ Right Click: Hold and drag to translate fractal.
+ J | M Keys: Toggle between Julia and Mandelbrot.