diff --git a/README.md b/README.md index 50d049ab..da0161d5 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ --- FRC circuit simulator for electronics diagramming and rookie training.
-Created by **TKO Programming** ([Andy Li](https://github.com/AndyLi23) and [Rohan Bansal](https://github.com/Rohan-Bansal)). +Created by **TKO Programming** ([Rohan Bansal](https://github.com/Rohan-Bansal) and [Andy Li](https://github.com/AndyLi23)). ## Features -- Circuit diagramming with FRC parts** (see subsection below) +- Circuit diagramming with FRC parts* (see subsection below) - Creating, moving, editing devices and cables - Saving/importing circuits as files - Automated debugging for all errors @@ -19,7 +19,7 @@ Created by **TKO Programming** ([Andy Li](https://github.com/AndyLi23) and [Roha ## Future Updates - Curved cables -- Accurate scaling of parts on a blocks-per-inch grid for E-Plate diagrams +- Accurate scaling of parts on a blocks-per-inch grid for E-Plate diagramming - Actual simulation of gauges, pistons, motors - Recursive debugging of all connected components - Timed competitive wiring games @@ -27,11 +27,11 @@ Created by **TKO Programming** ([Andy Li](https://github.com/AndyLi23) and [Roha ## Installation -#### Releases +#### Official Packaging Head over to the [releases](https://github.com/MittyRobotics/tko-electronics-sim/releases) page and download the binary for your platform. Directions for installation are also included there. -#### Gradle +#### Building from Source 1. Clone the repository using git 2. Run `gradlew build` and then `gradlew run` in a console in the top directory