-
Notifications
You must be signed in to change notification settings - Fork 681
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
Add info on README about how to run from source, how to upgrade #621
Conversation
## Usage | ||
|
||
When the install is complete, go ahead and run this in your terminal: | ||
When install is complete, run: |
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.
I think this should stay as "When the install", alternatively you could use "When installation is..."
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.
Good catch, addressed, thanks!
``` | ||
```sh | ||
git clone https://github.com/thelounge/lounge.git | ||
cd lounge |
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.
They may clone into a different directory, maybe cd path/to/lounge
?
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.
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.
|
5d854a1
to
e5f4c5c
Compare
@xPaw, as in, |
That would be one of the cases, yes. I remember someone having this issue on irc. |
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 |
This can be an issue on certain services: https://devcenter.heroku.com/changelog-items/688 |
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. |
Run this in a terminal to install (or upgrade) the latest stable release from | ||
[npm](https://www.npmjs.com/): | ||
|
||
```sh | ||
sudo npm install -g thelounge |
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.
Might as well remove sudo
and mention the need for root privileges on certain setups?
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.
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!
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.
Done.
This is already on the badge and at the top of the page, on GitHub UI, as well as in 2 places in npm.
e5f4c5c
to
ae2b27b
Compare
…-source Add info on README about how to run from source, how to upgrade
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!