Generate a README with common documentation #88
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.
I was recently given a project that contained a front end generated by the React Zeal generator.
This project (which contained the Zeal application embedded in a Rails app) posted many difficulties in getting the application up, and obviously your generator contains some nicities that I would have had to find purely by reverse engineering the application. (ie theming).
(I'm sure you can figure out what those difficulties were by looking at the readme and seeing where that leans ;) )
By pure luck I managed to find that this was automatically generated code, not artisanally, handcrafted code, and that this was the source code for that generator!
My patch adds a
README.md
to the client folder, such that every new project generated will have some idea about origin of the code, getting-it-up-on-my-machine concerns, and other potentially common problems that may technically be the domain of downstream projects, but are worth documenting here as a one stop shop).Of course, as generated code, the user is free to delete the README or repurpose it, like so many README files in so many Rails generated projects.
Also, say hi to Frank for me. ;-)