chore: Update Scala version to 3.8.3 and maxColumn to 100 in .scalafm…

…t.conf

.scalafmt.conf

@@ -1,3 +1,5 @@
-version = "3.7.17"
+version = "3.8.3"
 runner.dialect = scala3
-maxColumn = 90 # For my wide 30" display.
+maxColumn = 100 # For my wide 30" display.
+runner.dialectOverride.allowSignificantIndentation = false
+runner.dialectOverride.allowQuietSyntax = true

README.md

@@ -1,29 +1,14 @@
 # dependentChisel
-This is the Master thesis : Dependent Chisel: Statically-checked hardware designs based on Chisel and Scala 3, by Yuchen du
+This is the impl for Master thesis : Dependent Chisel: Statically-checked hardware designs based on Chisel and Scala 3, by Yuchen du
 https://github.com/doofin/dependentChisel/blob/master/Msc_Thesis_yuchen.pdf
 
-It uses partial dependent types in Scala 3 to provide early error message for Chisel.
+It uses partial dependent types in Scala 3 to provide early error message for Chisel, a hardware description language embedded in Scala.
+This allows you to identify bitwidth mismatch at compile time where IDE can show errors instantly in the editor.
 
-## theories and related work
-related work : https://github.com/doofin/dependentChisel/blob/master/resources.md
-
-## interop with chisel
-
-Although scala 3 can invoke scala 2.13 libraries,chisel uses scala 2 macros different from scala 3 ,making it partially incompatible.
-
-here are some proposed ways :
-
-    rewrite all macros and make everything compat
-    rewrite some macros and extend some base class
-    write a new frontend and emit firrtl
-
-# compile and run
-This is a sbt project for Scala 3
-
-    run : `sbt run`
-    compile : `sbt compile` 
+## examples
+examples like adder, etc. can be found in src/test/scala/dependentChisel/
 
-an simple adder example: 
+some inline examples:
 
 ```scala
   class Adder1(using GlobalInfo) extends UserModule {
@@ -34,8 +19,59 @@ an simple adder example:
     y := a + b
   }
 ```
+A parameterized adder with static guarante:
+
+```scala
+  class AdderParm[I <: Int: ValueOf](using GlobalInfo) extends UserModule {
+    val a = newInput[I]("a")
+    val b = newInput[I]("b")
+    val y = newOutput[I]("y")
+
+    y := a + b
+  }
+```
+
+Instantiate those modules : 
+```scala
+  class AdderComb4(using parent: GlobalInfo) extends UserModule {
+
+    val a = newInput[2]("a")
+    val b = newInput[2]("b")
+    val c = newInput[2]("c")
+    val d = newInput[2]("d")
+    val y = newOutput[2]("y")
+
+    val m1 = newMod(new AdderParm[2])
+    val m2 = newMod(new AdderParm[2])
+
+    m1.a := a
+    m1.b := b
+    m2.a := c
+    m2.b := d
+
+    y := m1.y + m2.y
+  }
+```
+
+
+## Interop with chisel
+The current implementation is based on Chisel 3.5.1, which is used internally. There's no direct interop with the original Chisel, but you can probably use the generated FIRRTL for that.
+
+
+Although scala 3 can invoke scala 2.13 libraries,chisel uses scala 2 macros different from scala 3 ,making it partially incompatible.
+
+To fix the mismatch, there are several possible ways:
+
+- Rewrite all macros and make everything compatible.
+- Rewrite some macros and extend some base class.
+- Write a new frontend and emit FIRRTL.
+
+# compile and run
+This is a sbt project for Scala 3
+
+    run : `sbt run`
+    compile : `sbt compile` 
 
-# test
 
 many tests under src/test can be run by 
     sbt test
@@ -46,6 +82,10 @@ many tests under src/test can be run by
 
 [IntelliJ](https://blog.jetbrains.com/scala/)
 
+## theories and related work
+related work : https://github.com/doofin/dependentChisel/blob/master/resources.md
+
+
 ## misc
 
 with

src/test/scala/dependentChisel/examples/adder.scala

@@ -13,7 +13,6 @@ import dependentChisel.typesAndSyntax.chiselModules.*
 import dependentChisel.typesAndSyntax.varDecls.newIO
 import dependentChisel.codegen.compiler.*
 
-// import dependentChisel.api.*
 
 import dependentChisel.typesAndSyntax.varDecls.newIODym
 
@@ -28,10 +27,8 @@ object adder extends mainRunnable {
     chiselMod2verilog(mod)
   }
 
-  /* static adder
-
-
-   */
+  /** static adder with 2 inputs and 1 output
+    */
   class Adder1(using GlobalInfo) extends UserModule {
     val a = newIO[2](VarType.Input)
     val b = newIO[2](VarType.Input)
@@ -40,16 +37,8 @@ object adder extends mainRunnable {
     y := a + b
   }
 
-  /*
-  parametric static adder
-
-
-
-
-
-
-
-   */
+  /** static adder, parameterized
+    */
   class AdderParm[I <: Int: ValueOf](using GlobalInfo) extends UserModule {
     val a = newInput[I]("a")
     val b = newInput[I]("b")