setup nix flake (poorly) (#40)

* mct

* lift clash sources to root

* update nix

* ragequit nix

* non-cabal nix works

* base flake, downgrade clash 1.8.1, new ci

* devShell -> devShells

* retry ci

* fixed fr

* add clash-ghc

* get ci off nix

* cabal bs

* remove --enable-tests

* move cd

* remove haskell ci

Author: raquentin

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
 
       - name: Run Simulation
         run: |
-          cd hdl/sv/moving_average_accumulator
+          cd cores/moving_average_accumulator
           make test
 
 

hdl/sv/moving_average_accumulator/Makefile renamed to cores/moving_average_accumulator/Makefile

@@ -0,0 +1,56 @@
+<!-- omit in toc -->
+# Simple Nix Starter Project
+This starter project contains the scaffolding needed to integrate Clash with the Nix Stack build system. Read [Simple Starter Project](https://github.com/clash-lang/clash-starters/blob/main/simple/README.md) for more information on the various files.
+
+<!-- omit in toc -->
+# Table of Contents
+- [Getting this project](#getting-this-project)
+- [Building and testing this project](#building-and-testing-this-project)
+- [REPL](#repl)
+- [Adding custom dependencies / updating nix](#adding-custom-dependencies--updating-nix)
+
+# Getting this project
+Run `nix-shell --packages stack --run "stack new my-clash-project clash-lang/simple-nix"`.
+
+# Building and testing this project
+Build the project with:
+
+```bash
+nix-build
+```
+
+Verilog code will be available under the `result/share/verilog` directory.
+Modify the `hdl` variable in `default.nix` to configure whether to generate
+SystemVerilog or VHDL.
+
+However development itself is more streamlined by using a Nix shell. Start one 
+by invoking:
+
+```
+nix-shell
+```
+
+Then, to run the tests defined in `tests/`:
+
+```bash
+cabal run test-library
+cabal run doctests
+```
+
+To compile the project to VHDL run:
+
+```bash
+cabal run clash -- Example.Project --vhdl
+```
+
+You can find the HDL files in `vhdl/`. The source can be found in `src/Example/Project.hs`.
+
+# REPL
+Clash offers a [REPL](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) as a quick way to try things, similar to Python's `python` or Ruby's `irb`. Open the REPL by invoking:
+
+```
+cabal run clashi
+```
+
+# Adding custom dependencies / updating nix
+`niv` is available after opening `nix-shell`. See [niv on Hackage](https://hackage.haskell.org/package/niv) for more information.

hdl/sv/moving_average_accumulator/moving_average_accumulator.sv renamed to cores/moving_average_accumulator/moving_average_accumulator.sv

@@ -1,5 +1,5 @@
 packages:
-  punt-engine-haskell-cores.cabal
+  pipelined-order-book.cabal
 
 write-ghc-environment-files: always
 

hdl/sv/moving_average_accumulator/tb.cpp renamed to cores/moving_average_accumulator/tb.cpp

@@ -0,0 +1,12 @@
+cradle:
+  cabal:
+    - path: "./src"
+      component: "lib:pipelined-order-book"
+    - path: "./tests/doctests.hs"
+      component: "pipelined-order-book:doctests"
+    - path: "./tests"
+      component: "pipelined-order-book:test-library"
+    - path: "./bin/Clashi.hs"
+      component: "pipelined-order-book:exe:clashi"
+    - path: "./bin/Clash.hs"
+      component: "pipelined-order-book:exe:clash"

cores/pipelined_order_book/README.md

@@ -1,7 +1,7 @@
 cabal-version:       2.4
-name:                punt-engine-haskell-cores
+name:                pipelined-order-book
 version:             0.1
-license:             MIT
+license:             GPL-3.0-only
 author:              Race Williams <[email protected]>
 maintainer:          Race Williams <[email protected]>
 
@@ -75,6 +75,7 @@ common common-options
     Cabal,
 
     -- clash-prelude will set suitable version bounds for the plugins
+    -- TODO: get to work with 1.8.2
     clash-prelude >= 1.8.1 && < 1.10,
     ghc-typelits-natnormalise,
     ghc-typelits-extra,
@@ -85,25 +86,20 @@ library
   import: common-options
   hs-source-dirs: src
   exposed-modules:
-    FixParser.Top
     Example.Project
   default-language: Haskell2010
 
--- Builds the executable 'clash', with punt-engine-haskell-cores project in scope
+-- Builds the executable 'clash', with pipelined-order-book project in scope
 executable clash
   main-is: bin/Clash.hs
   default-language: Haskell2010
-  Build-Depends: base, clash-ghc, punt-engine-haskell-cores
-  if !os(Windows)
-    ghc-options: -dynamic
+  Build-Depends: base, clash-ghc, pipelined-order-book
 
--- Builds the executable 'clashi', with punt-engine-haskell-cores project in scope
+-- Builds the executable 'clashi', with pipelined-order-book project in scope
 executable clashi
   main-is: bin/Clashi.hs
   default-language: Haskell2010
-  if !os(Windows)
-    ghc-options: -dynamic
-  build-depends: base, clash-ghc, punt-engine-haskell-cores
+  build-depends: base, clash-ghc, pipelined-order-book
 
 test-suite doctests
   type:             exitcode-stdio-1.0
@@ -113,7 +109,7 @@ test-suite doctests
   hs-source-dirs:   tests
   build-depends:
     base,
-    punt-engine-haskell-cores,
+    pipelined-order-book,
     doctest-parallel >= 0.2 && < 0.4,
 
 test-suite test-library
@@ -126,10 +122,10 @@ test-suite test-library
   other-modules:
     Tests.Example.Project
   build-depends:
-    punt-engine-haskell-cores,
+    pipelined-order-book,
     QuickCheck,
     clash-prelude-hedgehog,
     hedgehog,
-    tasty >= 1.2 && < 1.5,
+    tasty >= 1.2 && < 1.6,
     tasty-hedgehog,
     tasty-th