Bug 1165 - Adding documented code examples for nMigen
Summary: Adding documented code examples for nMigen
Alias: None
Product: Libre-SOC's first SoC
Classification: Unclassified
Component: Documentation (show other bugs)
Version: unspecified
Hardware: PC Linux
: --- enhancement
Assignee: Andrey Miroshnikov
URL: https://libre-soc.org/docs/learning_n...
Depends on:
Reported: 2023-09-19 16:55 BST by Andrey Miroshnikov
Modified: 2023-09-24 14:20 BST (History)
3 users (show)

See Also:
NLnet milestone: ---
total budget (EUR) for completion of task and all subtasks: 0
budget (EUR) for this task, excluding subtasks' budget: 0
parent task for budget allocation:
child tasks for budget allocation:
The table of payments (in EUR) for this task; TOML format:


Note You need to log in before you can comment on or make changes to this bug.
Description Andrey Miroshnikov 2023-09-19 16:55:59 BST
As a learning exercise with Shriya, I created a repo containing nMigen code examples that a beginner could start running after setting up a Libre-SOC environment.

The intention of the code:
- Simple enough to understand
- Generates verilog output
- Generates gtkw trace file for nicer gtkwave output

Examples will be taken from existing projects (nMigen, etc.) or newly written.
Comment 1 Luke Kenneth Casson Leighton 2023-09-19 17:55:09 BST
i added the URL where all of the tutorials and everything i could find
is located. please remember UNDER NO CIRCUMSTANCES quote or reference
any Trademark-violating work.
Comment 2 Andrey Miroshnikov 2023-09-24 14:20:29 BST
First commit, added up_counter.py example from the nmigen gitlab repo, modified to include gtkw file generation (for pretty gtkwave traces).

There's enough to run the example, but I haven't added the details to the guide that I'm planning to.