Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix and enrich README.md #33

Merged
merged 2 commits into from Jun 17, 2022
Merged

Fix and enrich README.md #33

merged 2 commits into from Jun 17, 2022

Conversation

yihuajack
Copy link
Collaborator

Previous example 1 seems problematic:

Traceback (most recent call last):
File "/home/ayka-tsuzuki/.local/bin/sootty", line 8, in
sys.exit(main())
File "/home/ayka-tsuzuki/.local/lib/python3.9/site-packages/sootty/main.py", line 94, in main
raise Exception(
Exception: Unknown wires {'core.inst', 'core.pc'}
The following wires were detected in the wiretrace:
{'inst', 'mem_write', 'write_next', 'pc_next', 'in1', 'sreg', 'reg_dst', 'alu_op', 'addr', 'waddr_next', 'opcode', 'clk', 'sdata', 'in2', 'pc', 'op', 'alu_in1', 'alu_out', 'wreg', 'mem_read', 'branch', 'wdata_next', 'alu_src', 'funct', 'treg', 'reg_write', 'mem_to_reg', 'alu_shift', 'out', 'zero', 'rst_n', 'i', 'wdata', 'immed', 'wreg_next', 'tdata', 'rdata', 'alu_in2'}

Wires are supposed to be pc and inst, otherwise not runnable.

- [viu](https://github.com/atanunq/viu)

```bash
# From source
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that you added multiple methods for installation depending on the platform.

Copy link
Owner

@Ben1152000 Ben1152000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very nice! The README file was definitely in need of an update. Feel free to merge this commit into the main branch.

@Ben1152000 Ben1152000 added the documentation Improvements or additions to documentation label Jun 17, 2022
@Ben1152000 Ben1152000 merged commit 02167b6 into Ben1152000:master Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants