This repository has been archived by the owner on Sep 6, 2024. It is now read-only.
Write fully featured MAC +ARP + IP example #119
Labels
User interface
We want the core to be easy to use
Feature description
We would like to have a few example stacks for users of our core. This one is for a fully featured MAC + ARP + IP example. The module should live in
Clash.Cores.Ethernet.Examples
. For the PHY use a dummy with clear documentation that a user should use one for their specific protocol (RGMII. MII, etc)Expected behaviour
A clearly documented example. This should be in the form of a (large )haddock comment including a doctest.
Expected steps
Implement example.
Additional Context
See https://github.com/clash-lang/clash-compiler/blob/948ad7d486350ef99c41ee4b7c8cec2857fde49e/clash-cores/src/Clash/Cores/Crc.hs for an example how to write haddock examples including doctest.
The text was updated successfully, but these errors were encountered: