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 "Setting up a development environment" chapter #72

Merged
merged 2 commits into from
Dec 20, 2023
Merged

Conversation

exelotl
Copy link
Member

@exelotl exelotl commented Nov 17, 2023

This has taken a while, and there's a bit more to do, sorry!

The setup.md chapter itself is in good shape but there are fixes to be made to the following chapter(s), as they refer to things that made sense in relation to the old setup chapter but not this new one. For example:

  • references to files under the old code structure
  • mentioning the emulators of the time (VBA) where today's emulators would be more appropriate
  • a whole bit dedicated to teaching the reader how to write their own makefiles - do we want to keep this? It'll need some work either way.
  • references to the Programmer's Notepad IDE

I've made a start on fixing some of this stuff in the first.md chapter, will follow up with some more commits soon. In the meantime, I figured it'd be good to get this PR up and get some feedback on it. Enjoy!

Fix #2

@exelotl
Copy link
Member Author

exelotl commented Dec 19, 2023

This should be good to review now!

I think there's still plenty of improvements that could be made to first.md but they can come later - all the content in its current state hopefully flows properly and doesn't leave the reader wondering "where did that come from??"

@exelotl exelotl marked this pull request as ready for review December 19, 2023 00:11
Copy link
Sponsor Member

@avivace avivace left a comment

Choose a reason for hiding this comment

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

Amazing, thanks @exelotl . I started taking a look at it.

Could you move the "notes", "warning" and "danger" boxes (if any) to new admonition boxes we have? The syntax is very simple:

:::<TYPE> Title

Body of the box
:::

<TYPE> can be tip, warning or danger

@exelotl exelotl requested a review from avivace December 19, 2023 15:16
avivace pushed a commit that referenced this pull request Dec 20, 2023
avivace pushed a commit that referenced this pull request Dec 20, 2023
Clean up CSS and make <dfn> tags bold-italic

first.md: replace <tt> with italics

setup.md/first.md content changes

setup.md:
- Explain manual build steps
- Reword some things
- Ensure what's explained matches what's mentioned in first.md

first.md:
- Remove hand-rolled Makefile
- Remove reference to Programmer's Notepad
- Point to community instead of 'troubleshooting' section which no longer exists

Minor formatting/style tweaks

Remove metadata

setup.md switch to new admonition syntax

Remove -mthumb-interwork from build steps example
Clean up CSS and make <dfn> tags bold-italic

first.md: replace <tt> with italics

setup.md/first.md content changes

setup.md:
- Explain manual build steps
- Reword some things
- Ensure what's explained matches what's mentioned in first.md

first.md:
- Remove hand-rolled Makefile
- Remove reference to Programmer's Notepad
- Point to community instead of 'troubleshooting' section which no longer exists

Minor formatting/style tweaks

Remove metadata

setup.md switch to new admonition syntax

Remove -mthumb-interwork from build steps example
@avivace avivace merged commit 100cf4a into master Dec 20, 2023
avivace pushed a commit that referenced this pull request Dec 20, 2023
djedditt pushed a commit to djedditt/tonc that referenced this pull request Feb 4, 2024
djedditt pushed a commit to djedditt/tonc that referenced this pull request Feb 4, 2024
Clean up CSS and make <dfn> tags bold-italic

first.md: replace <tt> with italics

setup.md/first.md content changes

setup.md:
- Explain manual build steps
- Reword some things
- Ensure what's explained matches what's mentioned in first.md

first.md:
- Remove hand-rolled Makefile
- Remove reference to Programmer's Notepad
- Point to community instead of 'troubleshooting' section which no longer exists

Minor formatting/style tweaks

Remove metadata

setup.md switch to new admonition syntax

Remove -mthumb-interwork from build steps example
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.

Redo the "setting up a development environment" chapter
2 participants