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.

Sign up for GitHub

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

Jump to bottom

Add documentation for Microcontroller #603

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add documentation for Microcontroller #603

wants to merge 3 commits into from

Conversation

Desour
Copy link
Contributor

@Desour Desour commented Mar 30, 2022

  • (And also fix invalid code in T-Flop example.)
  • The html was autogenerated from the md (see comment).
  • The images were optipnged.
  • I don't know if there is more needed for https://mesecons.net.
  • Btw. an example for a bug: You can make the eeprom larger using sbi(1,(1)) or sbi(1, a1).

@Desour
Add documentation for Microcontroller
ff80b3f 
(And also fix invalid code in T-Flop example.)
SmallJoker
SmallJoker reviewed Jun 20, 2022
View reviewed changes
mesecons_microcontroller/doc/microcontroller/description.md
* Spaces and tabs outside of strings are ignored.
* Basic command syntax:
```
command_name`(`param1`,` param2`,` ...`)`
Copy link
Member

Choose a reason for hiding this comment

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

Why are the backticks needed?

EDIT: This list point might not be necessary. The commands are listed with better examples below anyway.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They're not needed. I added them because of my taste.
Imo it is useful to have this here. But it can be removed, if you wish.

Copy link
Member

Choose a reason for hiding this comment

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

What's the purpose of the backticks? What are they showing? In the generated HTML they appear as-is, without any formatting or whatsoever.

grafik

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah. I added them so that you can differentiate the literal letters from the variables.

Copy link
Member

Choose a reason for hiding this comment

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

Oh well that's more confusing than practical IMO, but if you would like to have it this way - alright...

Desour and others added 2 commits June 20, 2022 23:26
@SmallJoker
Copy link
Member

👍 LGTM

@Desour Desour mentioned this pull request Jul 27, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sfan5 sfan5 sfan5 left review comments

@SmallJoker SmallJoker SmallJoker left review comments

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Desour @SmallJoker @sfan5