Enhance README with Improved Setup Instructions and Clarity#470
Open
grtn316 wants to merge 1 commit into
Open
Conversation
… steps and moved the contrib and license guidelines to the bottom
BravoSimone
reviewed
Mar 8, 2025
BravoSimone
left a comment
BravoSimone
left a comment
There was a problem hiding this comment.
I left a comment here.
Also, there are some other typos in the original version of the README.md, you could address them here.
You can try to run it through any software like Grammarly or ask ChatGPT to show you them.
| <!-- PROJECT LOGO --> | ||
| <p align="center"> | ||
|
|
||
| <h1 align="center">Lago</h2> |
BravoSimone
reviewed
Mar 8, 2025
| #### 4️⃣ Set Up the Database | ||
|
|
||
| ```bash | ||
| docker compose exec api rails db:create |
There was a problem hiding this comment.
Also we can add a note that those are already done when we run docker compose up -d api
jdenquin
approved these changes
Aug 1, 2025
Contributor
|
@grtn316 sorry for the delay, can you rebase your changes and resolve conv if thats okay for you? 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the Lago README by:
Adding an intro about Lago to better describe its usage for people less familiar with the project.
Adding a clearer step-by-step breakdown of the local deployment process.
Providing explanations for each command to help users understand what they are executing.
Reorganizing sections for better readability and usability.
Clarifying environment variable configurations for non-local setups.
These updates aim to enhance the onboarding experience for new users.