Skip to content

Enhance README with Improved Setup Instructions and Clarity #470

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

grtn316
Copy link

@grtn316 grtn316 commented Feb 21, 2025

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.

… steps and moved the contrib and license guidelines to the bottom
Copy link

@BravoSimone BravoSimone left a comment

Choose a reason for hiding this comment

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

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.

@@ -1,18 +1,14 @@
<!-- PROJECT LOGO -->
<p align="center">

<h1 align="center">Lago</h2>

Choose a reason for hiding this comment

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

You should close a </h1> here

# Create the database
#### 4️⃣ Set Up the Database

```bash
docker compose exec api rails db:create

Choose a reason for hiding this comment

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

Also we can add a note that those are already done when we run docker compose up -d api

@jdenquin
Copy link
Contributor

jdenquin commented Aug 1, 2025

@grtn316 sorry for the delay, can you rebase your changes and resolve conv if thats okay for you? 🙏

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