Add info on README about how to run from source, how to upgrade

[astorije]

How to run from source and how to upgrade are 2 extremely common things asked on the IRC channel. Hopefully this is going to make things a bit more clear.

This closes #298.
Also, this aims to replace #614 and and #616, so I'd be happy to have feedback from @metsjeesus!

[MaxLeiter]

I think this should stay as "When the install", alternatively you could use "When installation is..."

[astorije]

Good catch, addressed, thanks!

[MaxLeiter]

They may clone into a different directory, maybe cd path/to/lounge?

[astorije]

If command run is git clone https://github.com/thelounge/lounge.git, then the new directory is going to be lounge in the current one, so running these 2 commands altogether should always be good.
If people decide to run git clone https://github.com/thelounge/lounge.git my-custom-dir, I believe them to be advanced enough to adapt the cd to their needs 😅.

Idea is by default you can just copy and paste these in a terminal and it should work as is.

[xPaw]

also the npm install needs to account for installing dev dependencies (If your npm env is prod, it won't install them, and the build will fail).

[astorije]

also the npm install needs to account for installing dev dependencies (If your npm env is prod, it won't install them, and the build will fail).

@xPaw, as in, export NODE_ENV=production being set system-wide? Just trying to understand, when can this be an issue? As in, when is such env being set? (I know it's the case for our current Dockerfile, but it's not following these instructions anyway)

[xPaw]

That would be one of the cases, yes. I remember someone having this issue on irc.

[astorije]

To be honest, I don't expect someone running installs from source to have their Node environment manually set up to production and being stuck because they don't have the development dependencies...

That seems like a specific scenario that I wouldn't want to worry about. Plus, running this on a prod machine, they need to realize that it should be done cautiously.

Also, "To run from source, run npm install && npm start" is kind of the de facto standard when it comes to Node packages. I expect they would have the same issue whatever they install from source.
@xPaw, mind leaving this as is and see if that issue arises again on the channel and/or GitHub issues? I am tempted to say it could be misconfiguration or miscomprehension in most cases.

[xPaw]

This can be an issue on certain services: https://devcenter.heroku.com/changelog-items/688

[astorije]

Then I still think people should be aware that running from source is not a good idea for production, and Heroku redirects them to https://devcenter.heroku.com/articles/nodejs-support#runtime-behavior.
Still believe we should do NODE_ENV=development npm install instead?
I don't have a strong opinion, I'm just puzzled (also, our Heroku doc does do simply npm install so we might not even have a choice, sigh...).

[williamboman]

Might as well remove sudo and mention the need for root privileges on certain setups?

[astorije]

Good point. Most often, people will document [sudo] npm install -g thelounge to indicate reader may need sudo or not depending on system. If this is not the first reader installs something on their machine, and it's extremely likely, they'll know what to do.
Will update this accordingly, thanks!

[astorije]

Done.