-
Notifications
You must be signed in to change notification settings - Fork 91
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
Use top-level README file #9
Comments
kevinbader
added a commit
to kevinbader/C4-Builder
that referenced
this issue
May 4, 2020
By ignoring the output folder (DIST_FOLDER), we allow a user to use the top-level directory as the source folder (ROOT_FOLDER). This is useful when the top-level README file provides introduction and getting-started material and should be included in the generated files. Closes adrianvlupu#9
This was referenced May 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Repositories typically have a top-level README file that explains what the project is about and how to get started using it. I think it would be helpful to re-use that file when generating the documentation using c4builder:
Are there already ways to achieve this or any thoughts on alternative approaches? If this sounds like a good idea I could also work on a PR for this.
The text was updated successfully, but these errors were encountered: