Add node / nvm build error note to the README.md

[Tweekism]

Close #91

[Tweekism]

I've put it here for now, with the build instructions.

If you want more details it might be better on its own page, like a troubleshooting or on the contributing page. To keep the front page README.md from getting too over whelming.

[jannis-baum]

I've put it here for now, with the build instructions.

If you want more details it might be better on its own page, like a troubleshooting or on the contributing page. To keep the front page README.md from getting too over whelming.

Yes sounds good. We can just link to the contributing under "compile yourself" on the readme and then put the instructions there. Would be great if you could also figure out the minimal version of Node required for SEA and add it there as well :)

[Tweekism]

Thats a good idea, then we can include more details, like we could list minimum versions for all the dependencies if we so wished.

I'll do that now.

[jannis-baum]

Hey, just as a heads-up: I just added Markdown linting to the repo, please rebase to main and make sure your changes will pass the linting rules :)

[Tweekism]

Hi guys,

Getting back to this today...

Is jq no longer a requirement at all?

EDIT: Also is zip needed? or have you switched to tar.gz? (I see zip still referenced in the makefile)

[jannis-baum]

Awesome!

Yes, jq is no longer a dependency :) We are dependency-free at runtime now.

zip still is a build dependency. We considered switching to tar but it got a bit ugly due to differences between BSD tar (on macOS) and GNU tar (on Linux) so we ended up on the thought that it's not quite worth it, especially since it is not needed at runtime anyways

[Tweekism]

Cool.

Question for both of you @jannis-baum @tuurep, when you are doing ./configure <install_path> ...Where are you guys installing to?

I'm installing to ~/.local/bin/ because I have write access there (without needing root) and it is on $path by default, but that might be a Fedora thing, doesn't seem to be the case on Ubuntu.

[jannis-baum]

We had a discussion about that topic starting in #68 (comment) and the next few comments.

tldr; I think Tuure installs to ~/.local/bin. On macOS we don't have any user-writable directory on $PATH by default so I started my own convention a long time ago at ~/.bin which I should probably change to be the conventional ~/.local/bin ^^ Installing to something you have write permissions to seems like the most sensible approach to us :)

[jannis-baum]

Hey this is super out of context but just as a heads-up for both of you @tuurep @Tweekism: I edited your PR descriptions to explicitly say Close #<issue-number> because this makes GitHub understand that the issue is linked to the PR and will also auto-close it on merge.

Maybe this is something we should also mention in the contribution guide? @Tweekism could you add it on your PR here since you are already editing that file anyways?☺️

[Tweekism]

Sure can mate, I was wondering why I wasn't getting the little icon on the issues page, I thought I had added it.

[Tweekism]

Hey peeps,

This is ready for you to have a look at, sorry it took so long, since it is a lot of change I know I'm holding up anyone else who wants to update the docs. Is it too much?

Note there is one "TODO:" in there, and that is the command to install the required dependencies on MacOS. Could you let me know? Or do we not want to go to that level of detail. I kind of modeled it after the Ladybird browser project that I flirted with a little bit 😅

[tuurep]

Yes I install to ~/.local/bin

and it is on $path by default, but that might be a Fedora thing

Same is true false on Arch and, but probably the most general convention there is

doesn't seem to be the case on Ubuntu.

Oh.. Interesting lol

[Tweekism]

Hey @tuurep,

Yeah I went back and had a look at that thread. Is that a default path on Arch?

edit: oh you ninja edited me, sneaky sneaky :)

[Tweekism]

doesn't seem to be the case on Ubuntu.

Oh.. Interesting lol

To be fair, I only checked on Ubuntu server, I’ll have a look on Ubuntu desktop see if it’s any different.

[tuurep]

Actually I went to double check if ~/.local/bin is on $PATH by default on Arch, and it's not 😄

I have this old line on my .bashrc:

# User scripts and python (pip) stuff
export PATH="$PATH:$HOME/.local/bin"

The comment reveals that I didn't know the full extent of what I was doing, but had set up ~/.local/bin initially to install stuff through pip 😄 So it hadn't been default.

Oh yeah it says user scripts too. Well, it's accurate enough.

[Tweekism]

That's interesting haha.

I'm in Windows at the moment (downloading Warzone updates 🙄). When I'm back in Linux I'll have a look at my .rc file.

[jannis-baum]

Hello! Thanks a lot for putting in the effort of writing such nice instructions here! I appreciate it a lot. See below for comments

[Tweekism]

Ok I've tightened it up significantly, and re-arranged a bit.

I'm going over it again double checking, let me know if thats better or if I missed anything.

[jannis-baum]

Nice, looks good! Let me know if everything is done from your side as well, if so I will merge this.

[Tweekism]

I just marked 2 backticks that I missed, other than that I'm happy.

[jannis-baum]

I just marked 2 backticks that I missed, other than that I'm happy.

Oh, did you fix that? I don't see any new changes.

[Tweekism]

I marked it in the code review thing but didn't commit it. Maybe you can't see them. Want me to just push a new commit?

[Tweekism]

I don't know how to do things on my phone. I have my laptop now give me 2 minutes and I'll fix up these to tiny things

[Tweekism]

Done.

I can squash those two new tiny commits into the previous one if you like.

[jannis-baum]

Done.

I can squash those two new tiny commits into the previous one if you like.

Yes sounds good!

[Tweekism]

Hows that look?

[jannis-baum]

Perfect! Then I will merge it, okay?👀

[jannis-baum]

Nice! Thanks a lot again and congrats on your first official contributions to Vivify🥳

[Tweekism]

I'd like to see this project go far because you guys are so nice. I've seen so many small projects die because they were run by one dude who didn't really like to talk to people 😅

[jannis-baum]

Thanks! I am also having lots of fun here working with you guys☺️ And I also still have some big plans for Vivify ^^ Namely the Jupyter Notebook thing

[jannis-baum]

Oh, and, speaking of plans, I was thinking to set up a GitHub project board soon where the issues from this and the vivify.vim repo are added automatically and then we can order stuff by what we each want to work on next to keep things more organized. Just as a heads up, you will get an e-mail invitation or something once that's ready :)