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

📝 Overhaul README #575

Merged
merged 12 commits into from
Sep 10, 2024
Merged

Conversation

thisiskeithb
Copy link
Member

@thisiskeithb thisiskeithb commented Aug 8, 2024

As the title states, completely overhaul the repository README.

The main focus (and entire reason I started down this path) was to add tested and working Ruby & Jekyll install procedures for local development/preview since the current instructions were woefully out of date and did not work.

This involved setting up new VMs for Windows 10, macOS 12.7.6 (limited by my hardware), & Ubuntu 24.04 LTS and validating each step to work out any bugs. After working out the steps & commands, VMs were reset to a fresh state & the updated Ruby/Jekyll install process was verified to work without issue.

H/t to @ellensp for being a sounding board while I bashed my head against the wall working through these issues.

Co-authored-by: ellensp <530024+ellensp@users.noreply.github.com>
@thisiskeithb
Copy link
Member Author

thisiskeithb commented Aug 19, 2024

This PR now relies on #579 since I've confirmed that everything builds in clean installs of Ubuntu 24.04 LTS, Windows 10, and macOS Monterey 12.7.6 (limited by my hardware) using Jekyll 3.10.0 & Ruby 3.3.4. Instructions have been updated accordingly.

I've also added Ubuntu instructions based on @ellensp's tips.

@thisiskeithb thisiskeithb marked this pull request as ready for review August 19, 2024 18:53
@thinkyhead
Copy link
Member

thinkyhead commented Aug 19, 2024

Homebrew is a popular macOS package manager, but I prefer to use MacPorts, and I wrote my earlier instructions with consideration for both the MacPorts package manager and Homebrew. It would be good to retain the instructions for both.

@thisiskeithb
Copy link
Member Author

It would be good to retain the instructions for both.

Noted. I'll verify the MacPorts instructions still work & adjust as necessary.

@thisiskeithb
Copy link
Member Author

I'll verify the MacPorts instructions still work & adjust as necessary.

We didn't exactly have complete MacPorts installation instructions before, but I tested & confirmed that the updated instructions work.

I vaguely remember something about paths being different if you're on an Arm-based Mac, so I need to double-check that and potentially split things up further.

@thinkyhead thinkyhead merged commit 458686a into MarlinFirmware:master Sep 10, 2024
1 check passed
@thisiskeithb thisiskeithb deleted the pr/overhaul_readme branch September 10, 2024 02:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants