Skip to content
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

Clarify README build instructions, Automate RC-file specification #4264

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

dstadulis
Copy link

@dstadulis dstadulis commented Feb 14, 2025

PR Description

  • Clarify README build instructions, Improve formatting
  • Automate alias target-file specification

Docs only change: N/A

  • [Doc's only change] Cheatsheets are up-to-date (run go generate ./...)
  • Code has been formatted (see here)
  • Tests have been added/updated (see here for the integration test guide)
  • Text is internationalised (see here)
  • If a new UserConfig entry was added, make sure it can be hot-reloaded (see here)

Checks

  • Docs have been updated if necessary
  • You've read through your own file changes for silly mistakes etc

README.md Outdated
git clone https://github.com/jesseduffield/lazygit.git
cd lazygit
go install
```

You can also use `go run main.go` to compile and run in one go (pun definitely intended)
### Compile Emphemeral Binary
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be four hashes cos it belongs to the above section

Copy link
Owner

@jesseduffield jesseduffield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one thing

@dstadulis
Copy link
Author

one thing

Indentation corrected per request.

PR should be ready for merge

@dstadulis
Copy link
Author

@jesseduffield The change-request GH review comment appears to be unavailable to be marked as resolved. But PR is ready for merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants