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.

Sign up for GitHub

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

Jump to bottom

Use top-level README file #9

Open
kevinbader opened this issue Apr 30, 2020 · 0 comments · May be fixed by #10
Open

Use top-level README file #9

kevinbader opened this issue Apr 30, 2020 · 0 comments · May be fixed by #10

Comments

@kevinbader
Copy link

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:

/README.md       # for website generation, use this as the start page (and assume it has a link to e.g. `doc/all-in-one.md`); for pdf, use this as the intro section
/src/context.md  # this is the "architecture overview" linked to in the top-level readme

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.
kevinbader added a commit to kevinbader/C4-Builder that referenced this issue May 4, 2020
@kevinbader
Allow using top-level dir as ROOT_FOLDER
989a50f 
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
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Allow using top-level dir as ROOT_FOLDER kevinbader/C4-Builder
1 participant
@kevinbader