-
Notifications
You must be signed in to change notification settings - Fork 806
Make checks scripts work on macOS + update readme #8694
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
base: main
Are you sure you want to change the base?
Conversation
4f2f504 to
9f6b237
Compare
jensmaurer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks mostly good.
9f6b237 to
4f1fe9b
Compare
|
@tkoeppe , this looks like an improvement. (The commit message could use an overhaul, mentioning the http -> https change as well. Maybe even in a separate commit.) |
c240136 to
c6cd247
Compare
| Using homebrew on macOS | ||
| ======================= | ||
|
|
||
| Instead of downloading packages from the internet, you can use the `HomeBrew package manager <https://brew.sh>` to install all that is needed to build the draft and run checks on it: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is "Instead of downloading packages from the internet" referring to? Does brew not download anything from the internet? And is this brew install mactex gnu-sed a complete replacement for the tlmgr installation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Brew validates the packages against known checksums. It's against general recommendation "thou shall not download and install stuff random from internet". Brew also manages updating it and also makes easy to uninstall, without depending on package specific way how to remove stuff.
Yes, brew install mactex is a complete replacement for the tlmgr installation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can also install BasicTeX using brew and then use tlmgr, but it felt really convoluted and I felt I would end up describing all the combinations. My intention with this PR is just to provide quickest and most straightforwards way how to start with this repo, hence the auto config of gsed instead of asking users to change their whole environment and probably introduce some future problems.
…t work on macOS) + update readme for macOS
c6cd247 to
16a793a
Compare
Scripts needs GNU sed, which is not available on macOS by default, but can be easily install with homebrew. If script detects presence of GNU sed, it will create a function to pass attributes from sed command to GNU sed.
I also updated
readme.rstaccordingly so it mentions homebrew so we don't need to point our users to download packages from internet, but they can just use the package manager.Also I updated
readme.rstand made all links https.