-
Notifications
You must be signed in to change notification settings - Fork 7
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
Improve installation: Use /usr/local/bin & simplify manual install #21
base: master
Are you sure you want to change the base?
Improve installation: Use /usr/local/bin & simplify manual install #21
Conversation
Reviewer's Guide by SourceryThis pull request improves the installation process by changing the installation path to Sequence diagram for the new installation processsequenceDiagram
actor User
participant Shell
participant GitHub
participant System
User->>Shell: Run install command
Shell->>GitHub: curl installation script
GitHub-->>Shell: Return install.sh
Shell->>Shell: Execute install.sh
Shell->>GitHub: git clone RASCII
GitHub-->>Shell: Return repository
Shell->>Shell: Build with cargo
Shell->>System: Copy binary to /usr/local/bin
System-->>User: Installation complete
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
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.
Hey @ShivangSrivastava - I've reviewed your changes - here's some feedback:
Overall Comments:
- Using
curl | sh
for installation is a security risk - users should be encouraged to download and inspect the installation script before running it. Consider providing the manual installation steps alongside a downloadable script. - The installation script assumes the RASCII directory doesn't exist and could fail if it does. Please add appropriate error checking and directory handling.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Thanks for the PR. Could you implement the suggested improvements please? |
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
Description:
This PR improves the installation process by:
Using
/usr/local/bin
instead of/usr/bin
/usr/local/bin
is the recommended location for user-installed binaries.Simplifying manual installation in the README
chmod +x
, users can now install with a single command:curl -sL https://raw.githubusercontent.com/orhnk/RASCII/refs/heads/master/install.sh | sh
These changes follow best practices and improve the user experience.
Summary by Sourcery
Update the installation script to install the binary to
/usr/local/bin
instead of/usr/bin
. Simplify the manual installation instructions in the README to a single command.Enhancements:
/usr/local/bin
for binary installation, which is the standard location for user-installed executables and prevents conflicts with system packages.curl
command that clones the repository, builds the binary, and installs it.