Added section for manually enabling auto command completion #52
Conversation
README.md
Outdated
|
|
||
|
|
||
| **Create and Save the Install Scripts** | ||
| ```sh |
There was a problem hiding this comment.
Could we include the two install scripts as files in the repo and just list them as a link to save?
There was a problem hiding this comment.
That's a really good idea. Please @alexs-gitK can you add them to a installation/windows folder?
There was a problem hiding this comment.
@jkelroy @sergiolms - It's not a good idea to create a downloadable script. This opens Gitkraken to a lot of liability. We should put a disclaimer that the code is for demonstration purposes only, and the end user should contact the system administrator before running any script. Moreover, if we do want to have a downloadable script, I would suggest the following;
- Put a disclaimer in the script that prompts the end user to acknowledge they are running this script and absolve Gitkraken of any responsibility or damages.
- Add a check-sum to this script to verify that the code has not been modified.
There was a problem hiding this comment.
But having the script in the README and asking to copy it isn't essentially the same thing as having it as a downloadable script in the repository? (See this installation script for Open Interpreter for instance).
Can't we have it uploaded in the repository and linked as I did in this comment?
I think that would ease the read of the README file.
People are still able to read what does the script do, and they can copy & paste it if they don't want to download it.
EDIT: Here are the docs of Open Interpreter where they give you instructions to download and use the file. Just in case they're useful to write up ours.
There was a problem hiding this comment.
@sergiolms - Semantically, having users manually create and run these scripts does shift the responsibility to them for any issues that may arise on their machines. By copying and pasting the scripts from the README, users are responsible for understanding and executing the code themselves.
I've updated the README to enhance readability and reiterate that the code is strictly for demonstration purposes. This is to set clear expectations and help users understand the limitations of the code. I also advise users to consult with their system administrators before running any scripts. Please see updates
No description provided.