docs: update home

This commit is contained in:
Administrator 2020-01-06 01:30:52 +00:00 committed by Josh Stewart
parent bc23008a18
commit ad48c48f9c
1 changed files with 16 additions and 2 deletions

18
home.md
View File

@ -2,9 +2,23 @@
title: Speeduino wiki
description: The Speeduino documentation wiki
published: true
date: 2020-01-05T22:40:43.415Z
date: 2020-01-06T01:30:51.552Z
tags:
---
# Speeduino Manual
This manual contains the hardware and software configuration details for getting started with Speeduino ECUs
This manual covers the hardware (sensors, wiring etc), software configuration and tuning elements related to running a Speeduino unit. When beginning with Speeduino, particularly if it is your first time installing and configuring an engine management system, this manual will assist in understanding Speeduino's capabilities and how it should be installed, both in terms of hardware and software/firmware.
Whilst this document will assist in providing information related to Speeduino's configuration, it does not cover advanced engine tuning, fuel / ignition strategies etc. As with any changes to engine management, the possibility of damage to hardware is very real should a system be configured incorrectly.
### Getting Started
In terms of starting out with Speeduino, it is generally recommended to first upload the firmware to your Arduino and get it connecting to the tuning software (Tuner Studio) before moving on to hardware assembly or wiring etc. Software setup and configuration on Speeduino can be completed without the need for any additional hardware to be present (Beyond the arduino itself) and this allows exploration of the software and options available before either an outlay of significant funds or a significant investment of time.
The following sections of this manual cover how to compile and upload the firmware, as well as creating a new project in Tuner Studio. It is strongly recommended to read these as a starting point.
### About this manual
As an open source project, this documentation is growing continually and this means that you may come across gaps in the documentation where little information is currently provided. Please do not hesitate to post on the forum if there is something missing that you need critically (or even not so critically).
Additionally, if you would like to contribute to the Speeduino documentation, we would love to hear from you! The preferred method to request wiki access is either via the forum (https://speeduino.com/forum/viewforum.php?f=9) or via Slack (https://speeduino.com/forum/app.php/page/slack)