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

New README.md #235

Merged
merged 4 commits into from
May 9, 2023
Merged

New README.md #235

merged 4 commits into from
May 9, 2023

Conversation

Ryvix
Copy link
Contributor

@Ryvix Ryvix commented May 9, 2023

Hopefully I did this right.

This is an update to the README.md file.

I added some steps on using the Generator but now I'm not sure if that should even go in here or in the Generator README.md. It seemed useful to know how to use WPBP properly though so I left it there.

I added descriptions and links to all the things in the wpbp.json file.

It's still missing some info under the Snippets section. For example it probably could use a description under the Snippets heading about what snippets actually are and where to find them. It also has some missing descriptions for some and there are no links to them since I don't know where or even what exactly they are. Maybe that will come when I get more experience using it all.

I sort of merged what I had before into the existing README.md so of course feel free to edit it however you like it. I'm not sure what parts you want to add/remove/replace, etc.

README.md Show resolved Hide resolved
@Mte90
Copy link
Member

Mte90 commented May 9, 2023

So I like the new version, is very better as explanation.

My doubts are just for the library list. I chose the table version to get a readme that is more shorter but in that way it is difficult to get the description. A solution could be use the table just to have 2 columns with a single row with all the descriptions.
For snippets they are in the boilerplate but points the position to the file can be a problem as it will means update the readme at every release to check if the line is changed. Reading your readme version I think that is complete as explanation.

About CMB2 as columns yes but in some cases you just want that library and not the whole CMB2.

README.md Show resolved Hide resolved
Mte90 and others added 3 commits May 9, 2023 11:45
Co-authored-by: Erik Golinelli <erik@codekraft.it>
@Mte90 Mte90 changed the title Update README.md New README.md May 9, 2023
@Mte90
Copy link
Member

Mte90 commented May 9, 2023

I think that now is perfect, what do you think @erikyo @Ryvix?

In case if you want to help further the project a review on https://wpbp.github.io/ can be interesting with a ticket on https://github.com/wpbp/wpbp.github.io

@erikyo
Copy link
Contributor

erikyo commented May 9, 2023

LGTM! 🚀

@Ryvix
Copy link
Contributor Author

Ryvix commented May 9, 2023

If you like it then I'm happy too. Nice work 😀

@Mte90 Mte90 merged commit e04ceb1 into WPBP:master May 9, 2023
13 checks passed
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.

None yet

3 participants