From 02ac78442727aa809ee07aecae05841450fba305 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:29:38 -0500 Subject: [PATCH 1/7] update External Links in README --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 88b659232e..12845266ef 100644 --- a/README.md +++ b/README.md @@ -35,15 +35,13 @@ Online and offline (PDF) versions of the user manual available here: https://wik # External Links -TODO - - + * [Wiki](https://wiki.fome.tech/) + * [Forum](https://www.fome.tech/forum) + * [Discord](https://discord.com/invite/5FQj4DMz) + * [Facebook](https://www.facebook.com/fome.tech) + # Contributors From eff3491f9cf24583f15863c3a92d0886339f7c93 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:31:19 -0500 Subject: [PATCH 2/7] add "free software" note to README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 12845266ef..82b8f7d402 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ # [FOME: Free Open Motorsports ECU](https://www.fome.tech/) -Welcome to FOME, a project intended to provide OEM quality open source engine controls with a focus on user-friendly design, stability and ease of use. +Welcome to FOME, a project intended to provide OEM quality open source engine controls and [free software](https://www.fsf.org/about/what-is-free-software) with a focus on user-friendly design, stability and ease of use. FOME intends to narrow the gap between the features and functions seen on modern OEM engine control systems and that expected from stand-alone engine control systems. At the same time FOME intends to improve the ease of working with these systems and help provide access to the learning resources needed to understand and tune engines effectively. From 2d75f1663a7f6ef978030e7621f08703343267f3 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:31:51 -0500 Subject: [PATCH 3/7] add Releases link to README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 82b8f7d402..22e4d7bd69 100644 --- a/README.md +++ b/README.md @@ -63,4 +63,4 @@ Check out https://rusefi.com/forum/viewtopic.php?f=5&t=9 # Release Notes -See [the changelog](firmware/CHANGELOG.md) +See [the changelog](firmware/CHANGELOG.md), or [by release](https://github.com/FOME-Tech/fome-fw/releases). From 231e4525f3629388935f819819d09aba54941f80 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:31:40 -0500 Subject: [PATCH 4/7] improve Contributors notes in README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 22e4d7bd69..502a7ea4a5 100644 --- a/README.md +++ b/README.md @@ -49,10 +49,12 @@ This project exists thanks to all the people who contribute their time, expertis If you'd like to get involved, see [contributing](CONTRIBUTING.md). -## Cloning the repository +## Getting Started +Clone the repository: `git clone https://github.com/FOME-Tech/fome-fw.git` +Initialize the checkout: `git submodule update --init` ## Building From 46e19edacce7d7ad7199bce7fa485fcf0b5a206e Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:40:35 -0500 Subject: [PATCH 5/7] separators for What Do We Have Here? in README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 502a7ea4a5..98176a7178 100644 --- a/README.md +++ b/README.md @@ -25,13 +25,13 @@ At present FOME shares a large amount of its core with the rusEFI project and mo Online and offline (PDF) versions of the user manual available here: https://wiki.fome.tech/ -# What do we have here? - * [Firmware](/firmware) Source code for open source engine control unit for stm32 chips - * [FOME console](/java_console) ECU debugging/development software - * [Simulator](/simulator) Windows or Linux version of firmware allows exploration without any hardware - * [Unit Tests](/unit_tests) Unit tests of firmware - * [Misc tools](/java_tools) Misc development utilities - * [misc/Jenkins](/misc/jenkins) Continuous integration scripts +# What Do We Have Here? + * [Firmware](/firmware) - Source code for open source engine control unit for stm32 chips + * [FOME console](/java_console) - ECU debugging/development software + * [Simulator](/simulator) - Windows or Linux version of firmware allows exploration without any hardware + * [Unit Tests](/unit_tests) - Unit tests of firmware + * [Misc tools](/java_tools) - Misc development utilities + * [misc/Jenkins](/misc/jenkins) - Continuous integration scripts # External Links From 03d7da7d49393f84008744f9d44652ec7deb4966 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:37:30 -0500 Subject: [PATCH 6/7] space in heading tags in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 98176a7178..f57b2aaa3d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ GPL open-source ECU -[![Release](https://img.shields.io/github/v/release/FOME-Tech/fome-fw?style=flat)](https://github.com/FOME-Tech/fome-fw/releases/latest)![Last Commit](https://img.shields.io/github/last-commit/FOME-Tech/fome-fw?style=flat) +[![Release](https://img.shields.io/github/v/release/FOME-Tech/fome-fw?style=flat)](https://github.com/FOME-Tech/fome-fw/releases/latest) ![Last Commit](https://img.shields.io/github/last-commit/FOME-Tech/fome-fw?style=flat) [![Unit Tests](https://img.shields.io/github/actions/workflow/status/FOME-Tech/fome-fw/build-unit-tests.yaml?label=Unit%20Tests&branch=master)](https://github.com/FOME-Tech/fome-fw/actions/workflows/build-unit-tests.yaml) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/FOME-Tech/fome-fw/latest?color=blueviolet&label=Commits%20Since%20Release) [![FOME Discord](https://img.shields.io/discord/1060875162892898324?label=Discord&logo=Discord)](https://discord.gg/5kC7vvpk7z) From bcbd0a035c22d824e6c5ac6836cc178518dcedf2 Mon Sep 17 00:00:00 2001 From: Nathan Schulte Date: Mon, 1 May 2023 10:31:03 -0500 Subject: [PATCH 7/7] trim trailing space in README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f57b2aaa3d..4d4a42d5fd 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ # [FOME: Free Open Motorsports ECU](https://www.fome.tech/) -Welcome to FOME, a project intended to provide OEM quality open source engine controls and [free software](https://www.fsf.org/about/what-is-free-software) with a focus on user-friendly design, stability and ease of use. +Welcome to FOME, a project intended to provide OEM quality open source engine controls and [free software](https://www.fsf.org/about/what-is-free-software) with a focus on user-friendly design, stability and ease of use. -FOME intends to narrow the gap between the features and functions seen on modern OEM engine control systems and that expected from stand-alone engine control systems. At the same time FOME intends to improve the ease of working with these systems and help provide access to the learning resources needed to understand and tune engines effectively. +FOME intends to narrow the gap between the features and functions seen on modern OEM engine control systems and that expected from stand-alone engine control systems. At the same time FOME intends to improve the ease of working with these systems and help provide access to the learning resources needed to understand and tune engines effectively. -FOME came about from a desire to enhance the user experience of rusEFI that was shared by a number of members of that project; over time it became apparent that the best way to achieve this goal was to begin working on a fork. Thus at the start of 2023 FOME was founded. +FOME came about from a desire to enhance the user experience of rusEFI that was shared by a number of members of that project; over time it became apparent that the best way to achieve this goal was to begin working on a fork. Thus at the start of 2023 FOME was founded. -The founding members would like to express gratitude towards rusEFI for its ground breaking work and the innovation it has brought to the ECU market. +The founding members would like to express gratitude towards rusEFI for its ground breaking work and the innovation it has brought to the ECU market. At present FOME shares a large amount of its core with the rusEFI project and most rusEFI boards are compatible with the FOME software; this is likely something that will continue to diverge over time, meaning full compatibility with older RE hardware cannot be guaranteed.