Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

README: link to build instructions, slight polish to Markdown #1520

Merged
merged 1 commit into from
Jan 7, 2025

Conversation

ilyagr
Copy link
Contributor

@ilyagr ilyagr commented Jan 3, 2025

I found it difficult to find the instructions for building MacVim from source, but very easy to build it once I found the instructions.

Hopefully, this will help others find these helpful instructions.

@ilyagr
Copy link
Contributor Author

ilyagr commented Jan 3, 2025

Perhaps https://github.com/macvim-dev/macvim/wiki/Building might be a better link.

@ychin
Copy link
Member

ychin commented Jan 6, 2025

Thanks for the PR. For now, it's probably better to link to https://github.com/macvim-dev/macvim/wiki/Building

It's definitely my bad that I haven't really updated the README yet. I really need to update the overall documentation of MacVim to make it easier to contribute and understand the overall layout and how to build/test MacVim.

Did you have any specific questions or roadblocks? It would be useful to know the issues you encountered other than just general lack of instructions (which is itself an issue…)

I found it difficult to find the instructions for building MacVim from source, but very easy to build it once I found the instructions.

Hopefully, this will help others find these helpful instructions.
@ilyagr
Copy link
Contributor Author

ilyagr commented Jan 6, 2025

For now, it's probably better to link to https://github.com/macvim-dev/macvim/wiki/Building

Done.

Did you have any specific questions or roadblocks?

Actually, I had a very good experience, the best by far out of all Mac applications I have tried to compile from source so far (I'm not a MacOS developer, I merely use MacOS to develop). Once I found the instructions, they just worked immediately and I had a ready-to-use app that ran correctly.

In my previous attempts (with other projects), I ran into weird library errors, things looking for libraries in wrong homebrew directories, or I at least had to fuss with XCode.

I compiled from source mainly wanted to get the fix for #1503 (which also works great BTW, thank you!) early, so I'm not sure I'll actually contribute much, but I'm more likely to become one than before. I don't use Vim as much these days, mostly VS Code or Kakoune.


To get nitpicky, one thing that maybe would be nice to add is an explanation of what flags to ./configure to use to get a build similar to the official one. I now realize some of it is explained in https://github.com/macvim-dev/macvim/wiki/Building#enabling-extra-features -- which is already pretty good -- but a copy-pastable line might help even more. (OTOH, if that line requires setting up the right Homebrew packages, mentioning it might be more trouble than it's worth) This wasn't a problem for me because I don't use any Python plugins, but I was surprised I got a build without Python when I ran ./configure with no arguments.

@ychin ychin merged commit 73de6ef into macvim-dev:master Jan 7, 2025
1 check passed
@ychin
Copy link
Member

ychin commented Jan 7, 2025

Looks good, merged!

To get nitpicky, one thing that maybe would be nice to add is an explanation of what flags to ./configure to use to get a build similar to the official one. I now realize some of it is explained in https://github.com/macvim-dev/macvim/wiki/Building#enabling-extra-features -- which is already pretty good -- but a copy-pastable line might help even more. (OTOH, if that line requires setting up the right Homebrew packages, mentioning it might be more trouble than it's worth)

That's a fair point. One thing that should be coming in near future is reproducible builds (#1506) where you can make a build identical to the official release (well, identical other than the digital signature which by definition is not reproducible unless you stole my key). As part of that I would need to include instructions how to build it. But yes it would include a bit more work with setting up Homebrew packages etc (it's more annoying than just installing the right packages as we compile gettext/libsodium manually so they target the right OS versions).

I compiled from source mainly wanted to get the fix for #1503 (which also works great BTW, thank you!) early, so I'm not sure I'll actually contribute much, but I'm more likely to become one than before. I don't use Vim as much these days, mostly VS Code or Kakoune.

Great! I do want to push a pre-release version out soon as it's been a while since I have made a release. You could opt in to that in the advanced setting (pre-releases are mostly just slightly less polished releases but for the most part should be fine). Otherwise a full release should come in 1-2 months.

@ychin ychin added the Non User Facing Non-user facing change. These issues do no need to show up in release notes. label Jan 7, 2025
@ilyagr
Copy link
Contributor Author

ilyagr commented Jan 7, 2025

Thanks for the review! No need to rush the (pre)release on my account.

@ychin ychin added this to the Release 181 milestone Feb 19, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Non User Facing Non-user facing change. These issues do no need to show up in release notes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants