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

Windows Setup Guide For Dummies #476

Merged
merged 4 commits into from
Aug 31, 2023
Merged

Conversation

Taialt97
Copy link
Contributor

This guide provides a step-by-step walkthrough for setting up a GP2040-CE development environment on a Windows machine. It covers everything from software installations to environment configurations, making use of the Raspberry Pi Pico SDK installer to simplify the process. Ideal for beginners, the guide aims to make your setup experience as straightforward as possible.

If you are very new to GP2040-CE development and working on a Windows machine, you can refer to the 'Windows Setup Guide For Dummies.' It's a bit more comprehensive and uses the Raspberry Pi Pico SDK installer, which makes everything a tad bit easier.
@InfraredAces
Copy link
Contributor

I believe the title should be reworded in a more professional manner if kept at all. It's a bit demeaning and seems out of place in documentation.

I also think there needs to be a decision on whether this should replace the existing instructions for Windows set up. Having it be an addition seems unnecessarily confusing, especially when you have the Linux instructions in between.

@Taialt97
Copy link
Contributor Author

I'll update the title. As for organizing the instructions, it might be best to create separate pages for Windows, Linux, and Mac development. This allows for easier, independent updates for each platform. I can then revamp the Windows page to make it more accessible for beginners.

@deeebug
Copy link
Contributor

deeebug commented Aug 29, 2023

I believe the title should be reworded in a more professional manner if kept at all. It's a bit demeaning and seems out of place in documentation.

I also think there needs to be a decision on whether this should replace the existing instructions for Windows set up. Having it be an addition seems unnecessarily confusing, especially when you have the Linux instructions in between.

On the topic of replacing the existing one, that one could be still kept as a full manual setup. It might give some troubleshooting insights or would be good for users who already have certain components installed and just want to get the SDK and whatnot. Perhaps call it, With Installer and Without Installer (Manual Setup).

@Taialt97
Copy link
Contributor Author

Sounds like a plan. Still, I think that splitting the page into multiple OS pages could make it clearer and easier to understand overall. You could visit the setup page, select your operating system, and avoid getting lost among unfamiliar OS. I can make two versions for you to choose from: one with separate pages and one with everything remaining as it is now but with the addition of "With Installer and Without Installer (Manual Setup)".

@Taialt97
Copy link
Contributor Author

I tried the three-page approach, but it didn't turn out well. I've consolidated everything onto one page with all the methods.

docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@Taialt97 Taialt97 left a comment

Choose a reason for hiding this comment

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

Most of the spaces and capital letters probably came from the editor I'm using. I will know for future projects to turn off the auto-spacing and corrections to avoid mistakes. Other than that, I've changed everything that you've mentioned. Thanks :D

@Taialt97 Taialt97 requested a review from arntsonl August 31, 2023 08:04
Copy link
Contributor

@arntsonl arntsonl left a comment

Choose a reason for hiding this comment

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

Looks good. I'll add any spaces above sections if we need them.

@arntsonl arntsonl merged commit 5c603d6 into OpenStickCommunity:main Aug 31, 2023
25 checks passed
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.

4 participants