update docs

tomcl · Sep 18, 2024 · 93862d7 · 93862d7
1 parent b7f27c0
commit 93862d7
Show file tree

Hide file tree

Showing 11 changed files with 27 additions and 41 deletions.
diff --git a/docs/ReadMeCodeAnalysis.md b/docs/ReadMeCodeAnalysis.md
@@ -1,6 +1,7 @@
 ---
 category: Documentation
 categoryindex: 1
+index: 4
 ---
 
 # Schematic Editor Features

diff --git a/docs/contact.md b/docs/contact.md
@@ -1,12 +1,13 @@
 ---
-layout: page
 title: Contact
 category: Documentation
 categoryindex: 1
-
+index: 6
 ---
 
-# General Issues
+# Contacts
+
+If you encounter any problems using or downloading the software, please see the [Gihub Issue](https://github.com/tomcl/issie/issues) page, or [create a new issue](https://github.com/tomcl/issie/issues/new) on the ISSIE GitHub repository. Any feedback and suggestions are also welcome - we keep feature request issues and usually manage to implement them!
 
-If you encounter any problems using or downloading the software, please see the [Gihub Issue](https://github.com/tomcl/issie/issues) page, or [create a new issue](https://github.com/tomcl/issie/issues/new) on the ISSIE GitHub repository. Any feedback and suggestions are also welcome!
+If you want to use ISSIE in an educational context contact Dr. Tom Clarke, [Department of Electronic & Electrical Engineering, Imperial College London](https://www.imperial.ac.uk/electrical-engineering).
 
diff --git a/docs/coolFeatures.md b/docs/coolFeatures.md
@@ -1,9 +1,8 @@
 ---
-layout: page
 title: Features
-permalink: /cool-features/
 category: Documentation
 categoryindex: 1
+index: 3
 ---
 
 # Features list

diff --git a/docs/index.md b/docs/index.md
@@ -1,36 +1,43 @@
+---
+title: Home
+category: Documentation
+categoryindex: 1
+index: 1
+---
+
 # What is ISSIE?
 
 * ISSIE is **a very easy-to-use schematic editor and simulator** for hierarchical design of **digital logic circuits**. Run it and see the built-in demos for what it can do! ISSIE is targeted at 1st year university students, but would be useful teaching in schools and even for quick hardware design and test in an industrial or research environment. For the latter use case although we allow Verilog input and output these features need a bit more work.
 * ISSIE was motivated because we found that industry-standard CAD systems were too complex and buggy to be learnt in labs, and when learnt still nasty to use. Other educational products were too limited. We wanted **a schematic-based system to teach hierarchical design and digital electronics visually that would scale to large designs**.
 * ISSIE is an **open source project at Imperial College London developed over 5 years by students**. The code is cross-platform and binaries are released for Windows and Silicon (Arm64) Mac targets.
-* ISSIE is implemented using nearly 46K lines of F#, the equivalent of 150K lines in a typical OOP language. ISSIE has **its own digital simulator**.
+* ISSIE is implemented using nearly 46K lines in the FP language F#, the equivalent of 150K lines in a typical OOP language. ISSIE's implementation is almost pure functional programming without assignment. This makes the codebase very maintainable! ISSIE has **its own digital simulator**, which uses **write-once semantics** on mutable arrays to be close to functional programming and also efficient.
+* ISSIE uses the [FABLE F# to Javascript compiler](https://fable.io/), [Elmish MVU framework](https://elmish.github.io/elmish/), and [Electron](https://www.electronjs.org/). This tool chain creates seemless cross-platform applications with simple and highly productive coding.
 * ISSIE can generate Verilog output to drive FPGAs and has an integrated system to do this directly using the **ISSIE-Stick** hardware.
 * For acronym geeks, ISSIE stands for: *Interactive Schematic Simulator with Integrated Editor*.
-
+<br><br>
 
 # Running ISSIE
 
 Go to the [latest ISSIE release](https://github.com/tomcl/issie/releases/latest). Scroll down this page till at the bottom you find the `Assets` section - this has binaries for Windows and Macos PCs. Download the appropriate one and unzip it anywhere (or add the dmg file to applications under Macos by double-clicking). No installation is required - ISSIE runs from the unzipped files under windows if you double-click the top-level `ISSIE.exe` file with the blue ISSIE chip icon. 
 
+<br><br>
 # Help and User Guides
 
 For more setup information see the  [Getting Started](https://github.com/tomcl/ISSIE#getting-started) section of the repo README.
 
-### A Beginners Tutorial On ISSIE
-
-Go through the  [User Guide](https://tomcl.github.io/issie/user-guide/).
-
-### ISSIE Under The Hood for Developers
+<br><br>
 
-The ISSIE [wiki](https://github.com/tomcl/issie/wiki) has a large amount of information on the details of how ISSIE is designed, referencing a few student project reports with (a lot) of detail and background.
+### A Beginners Tutorial On ISSIE
 
-### ISSIE Code documentation (auto-generated)
+Go through the  [User Guide](UserGuide.html).
+<br><br>
 
-F# XML documentation on the [ISSIE API](https://tomcl.github.io/issie/reference/index.html)
+### ISSIE for Developers
 
+* The ISSIE [wiki](https://github.com/tomcl/issie/wiki) has a large amount of information on the details of how ISSIE is designed, referencing a few student project reports with (a lot) of detail and background.
+* F# XML documentation on the [ISSIE API](reference/index.html)
 
 <br><br>
-
 # Acknowledgements
 
 - Marco Selvatici for the 8K lines of base code written for his 3rd year BEng FYP at Imperial College London.
@@ -47,11 +54,3 @@ F# XML documentation on the [ISSIE API](https://tomcl.github.io/issie/reference/
 - Dr Tom Clarke (Imperial College London, EEE department) for running HLP and his continued work maintaining and improving the 46K lines of ISSIE code throughout
 <br><br>
 
-
-# Contact
-
-If you encounter any problems using or downloading the software, please see the [Gihub Issue](https://github.com/tomcl/issie/issues) page, or [create a new issue](https://github.com/tomcl/issie/issues/new) on the ISSIE GitHub repository. Any feedback and suggestions are also welcome - we keep feature request issues and usually manage to implement them!
-
-if you want to use ISSIE in an educational context contact Dr. Tom Clarke, [Department of Electronic & Electrical Engineering, Imperial College London](https://www.imperial.ac.uk/electrical-engineering).
-
-<br><br>
diff --git a/docs/updates/2021-07-04-Issie-v2-1-0.md b/docs/updates/2021-07-04-Issie-v2-1-0.md
@@ -1,5 +1,4 @@
 ---
-layout: post
 title:  ISSIE v2.1.0
 date:   2021-07-04 15:52:01 +0100
 category: Updates

diff --git a/docs/updates/2022-05-04-Issie-v3-0-0.md b/docs/updates/2022-05-04-Issie-v3-0-0.md
@@ -1,11 +1,8 @@
 ---
-layout: post
 title:  ISSIE v3.0.0
 date:   2022-05-04 20:52:01 +0100
 category: Updates
-
 index: 2
-
 ---
 
 # ISSIE v3.0.0

diff --git a/docs/updates/2022-09-20-Issie-v3-0-1.md b/docs/updates/2022-09-20-Issie-v3-0-1.md
@@ -1,11 +1,8 @@
 ---
-layout: post
 title:  ISSIE v3.0.1
 date:   2022-09-18 01:00:01 +0100
 category: Updates
-
 index: 3
-
 ---
 
 # ISSIE v3.0.1

diff --git a/docs/updates/2022-12-25-Issie-v3-0-9.md b/docs/updates/2022-12-25-Issie-v3-0-9.md
@@ -1,11 +1,8 @@
 ---
-layout: post
 title:  ISSIE v3.0.9  - Happy Christmas!
 date:   2022-12-25 01:00:01 +0100
 category: Updates
 index: 4
-
-
 ---
 # ISSIE v3.0.9  - Happy Christmas!
 

diff --git a/docs/updates/2024-09-25-Issie-v5-2-0.md b/docs/updates/2024-09-25-Issie-v5-2-0.md
@@ -1,11 +1,8 @@
 ---
-layout: post
 title:  ISSIE v5.2.0
 date:   2024-09-25 01:00:01 +0100
 category: Updates
 index: 5
-
-
 ---
 # ISSIE v5.2.0
 

diff --git a/docs/userGuide.md b/docs/userGuide.md
@@ -1,8 +1,8 @@
 ---
-layout: page
 title: User Guide
 category: Documentation
 categoryindex: 1
+index: 2
 ---
 
 ## Getting Started

diff --git a/docs/verilogComp.md b/docs/verilogComp.md
@@ -1,9 +1,8 @@
 ---
-layout: page
 title: Verilog Component
-permalink: /verilog-comp/
 category: Documentation
 categoryindex: 1
+index: 5
 ---