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

New Assembly Addition Description #348

Merged
merged 8 commits into from
May 7, 2019
Merged

Conversation

equationcrunchor
Copy link
Collaborator

New tutorial for the operation of the simulator and how the computer works in more detail.

Copy link
Contributor

@ltagliaferri ltagliaferri left a comment

Choose a reason for hiding this comment

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

This context is a great improvement and I think will help the site users tremendously! I left a few comments and questions. The comments of the text should be quick fixes. I did have an open question about the accessibility of the colors of the simulators. Was this considered when creating these? If not, can it be checked now?

<b>STO 6: </b> Stores the value of the accumulator into the register at address 6.<br />
<b>HTR: </b> Tells the computer to stop.<br />
If you run this, you'll see that register 6 has a fixed point value of 42. The answer to life, the universe, and everything. Everything as it should be.<br />
Welcome to the IBM 704 simulator! Here we have a simple example to introduce you how it works.<br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

For the second sentence, I would remove simple because we don't know whether our readers will think this is simple or not (when writing code documentation, it is best to avoid judgement). It is also a little awkward in phrasing. I recommend this as a new second sentence:

To learn how it works, we'll walk through an example. 

Now, reading binary is rather difficult, so we’ve allowed you to see the possible interpretations of a word by
mousing over it. Note that the computer doesn’t know how to interpret words automatically-- it is up to the
programmer to tell the computer how to interpret each word. If you mess up, you can end up using your program as
data, or trying to execute numbers as instructions!<br/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of If you mess up I would say If you make a mistake as it is a little more formal but still friendly in tone.

@equationcrunchor
Copy link
Collaborator Author

Hey @ltagliaferri, can you also take a look at the descriptions we have for the other demos right now as well? Thanks

Copy link
Contributor

@ltagliaferri ltagliaferri left a comment

Choose a reason for hiding this comment

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

Thanks for addressing these. I think we can continue to go through accessibility throughout the site, but let's get the documentation through now so that we can take steps in the right direction! Thank you for working on these revisions.

@ltagliaferri ltagliaferri merged commit 7297d5e into master May 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants