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

[FEATURE] README Improvements #1236

Open
9 tasks done
Giuulob89 opened this issue Jul 17, 2022 · 0 comments
Open
9 tasks done

[FEATURE] README Improvements #1236

Giuulob89 opened this issue Jul 17, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@Giuulob89
Copy link
Contributor

Giuulob89 commented Jul 17, 2022

Is your feature request related to a problem? Please describe.

The current README is good, but still needs improvements in terms of the placement of the information, how much information is provided, and, finally, how the information is being provided.

Describe the solution you'd like

Despite people should read the entire README, this is rare, because normally they are just looking for specific information, so if the project has a better organization we'll provide a better experience too.

Describe alternatives you've considered

  • Add a tittle and image related to the project in the beginning;
  • Add a Description topic;
  • Add a dinamic summary of the topics in README;
  • Prerequisites better specified;
  • More icons and images to a more dinamic reading;
  • Better explanation of some commands;
  • Better explanation of user creation in the database postgres;
  • Better explanation of non-profit user creation (what are the relevant information?);
  • Make better the explanation of what type of user needs to run each command.

Additional context

This issue is a reference of the issue #1167

@Giuulob89 Giuulob89 added the enhancement New feature or request label Jul 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant