Skip to content

Commit ff10d0b

Browse files
committed
Explain that we need help with both the emulator and the assembler.
1 parent 1b52bcb commit ff10d0b

File tree

1 file changed

+43
-10
lines changed

1 file changed

+43
-10
lines changed

CONTRIBUTING.md

Lines changed: 43 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -55,20 +55,53 @@ us an electronic version of the document you have, that works for us.
5555

5656
### Contributing by Programming
5757

58-
We also need help in implementing the instructions and machine
59-
features we already have documentation for. Some important things
60-
that still need to be written are recorded in the [issues
61-
list](https://github.com/TX-2/TX-2-simulator/issues). Items which we
62-
think are good choices for fist-time contributors are [marked with the
63-
"good first issue"
58+
You can help by improving our TX-2 cross-assembler or by improving the
59+
TX-2 emulation.
60+
61+
Some important things that still need to be written are recorded in
62+
the [issues list](https://github.com/TX-2/TX-2-simulator/issues).
63+
Items which we think are good choices for fist-time contributors are
64+
[marked with the "good first issue"
6465
tag](https://github.com/TX-2/TX-2-simulator/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
6566

66-
The "good first issue" tags are marked that way mainly because they
67-
implement a simple instruction and there is something in the existing
68-
code to guide you.
67+
#### Assembler Improvements
68+
69+
Our assembler runs on a modern computer but produces code for the
70+
TX-2. Once the assembler fully supports the features of the original
71+
TX-2 assembler ("M4") we can use it to help [recover original TX-2
72+
software](https://tx-2.github.io/software/verifying-listings)
73+
including some historically important programs.
74+
75+
See ["good first issues" for the
76+
assembler](https://github.com/TX-2/TX-2-simulator/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22%20%20label%3Aassembler)
77+
for a list of specific things you could work on.
78+
79+
#### Emulator Improvements
80+
81+
82+
We also need help in implementing the instructions and machine
83+
features we already have documentation for.
84+
85+
All bugs with the "good first issue" can be tackled without a deep
86+
understanding of how the TX-2 worked. While having that in
87+
common, they fall into several categories:
88+
89+
[Opcode](https://github.com/TX-2/TX-2-simulator/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20%20label%3AOpcode)
90+
: Instructions which are not fully implemented yet, but where there is
91+
something in the existing code to guide you and the instruction
92+
doesn't require a deep understanding of the TX-2.
93+
94+
[I/O](https://github.com/TX-2/TX-2-simulator/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20%20label%3AI%2FO)
95+
: Enhancements to the emulation of TX-2 peripherals, where this does
96+
not require a deep understanding of the TX-2.
97+
98+
[Web](https://github.com/TX-2/TX-2-simulator/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22%20%20label%3AWeb)
99+
: Enhancements to the UI of the web-based simulator which don't rely
100+
on an understanding of how the TX-2 works in detail.
69101

70102
If you are planning a significant contribution which doesn't already
71-
have an issue, please create one and outline what you hope to do.
103+
have an issue, please create one and outline what you hope to do
104+
(email [email protected] if you cannot create an issue).
72105

73106
If you are unfamiliar with Github, or Git or Rust, please let us know
74107
so that we can help you to get started.

0 commit comments

Comments
 (0)