diff --git a/README.md b/README.md index 83a80a54..716e4469 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,13 @@ # Engine Simulator ![Alt text](docs/public/screenshot_v01.png?raw=true) --- -## **Warning: code is in development and will change frequently** +## **Warning: project is in development and will change frequently** --- ## What is this? This is a real-time internal combustion engine simulation **designed specifically to produce engine audio and simulate engine response characteristics.** It is NOT a scientific tool and cannot be expected to provide accurate figures for the purposes of engineering or engine tuning. -## Why is the code so sloppy? - -I wrote this to demo in a [YouTube video](https://youtu.be/RKT-sKtR970), not as a real product. If you would like it to become a usable product please reach out to me or join my Discord (link can be found in the description of the aforementioned YouTube video). I use this codebase for my own purposes and so it might change frequently and without warning. - ## How do I install it? This is a code repository and might not look like other software that you're used to downloading and installing (if you're not familiar with programming). To download a ready-to-use version of the application, navigate to the [releases page](https://github.com/ange-yaghi/engine-sim/releases), find the most recent release (ex. `v0.1.5a`), click "Assets" and download the .zip file with a name that starts with `engine-sim-build`. Unzip this file, then run `bin/engine-sim-app.exe`. The simulator should then start normally. @@ -47,7 +43,11 @@ The UI is extremely minimalistic and there are only a few controls used to inter ### Using the RPM hold The RPM hold feature will hold the engine at a specific RPM and also measure the engine's horsepower and torque at that RPM. You can enable RPM hold by pressing the `H` key. **You must then enable the dynomometer** (press the `S` key) in order for the RPM hold to take effect. To change the hold speed, hold the `G` key and scroll with the mouse wheel. The RPM hold will be shown on the `DYNO. SPEED` gauge in the lower left of the screen. -## How do I build it? +## Why is the code so sloppy? + +I wrote this to demo in a [YouTube video](https://youtu.be/RKT-sKtR970), not as a real product. If you would like it to become a usable product please reach out to me or join my Discord (link can be found in the description of the aforementioned YouTube video). I use this codebase for my own purposes and so it might change frequently and without warning. + +## How do I build it? (Ignore this section if you're not a developer!) **Note: this project currently only builds on Windows!** ### Step 1 - Clone the repository