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

Why multiple README.md? #40

Closed
zbeekman opened this issue Jun 29, 2015 · 3 comments · Fixed by #42
Closed

Why multiple README.md? #40

zbeekman opened this issue Jun 29, 2015 · 3 comments · Fixed by #42

Comments

@zbeekman
Copy link
Contributor

Hi Stefano,
I’m just curious what your rational of keeping README.md and doc/README-FLAP.md is. If you want to include it in the FORD documentation is there a reason that either:

  1. A symbolic link
  2. Specifying the path as ../README.md

won’t work? I think trying one of these approaches might help make your life easier so that you don’t have to remember to update the README.md in two places and git add & git commit it every time you update it.

@zbeekman
Copy link
Contributor Author

It seems that the symbolic link works. I’ll submit a PR with this, you can accept or reject it.

@szaghi
Copy link
Owner

szaghi commented Jun 29, 2015

Hi @zbeekman ,

The problem was that FORD uses main page path as its root, thus for I just like to have docs not into project root. Yes, links work: on my local repo the two readme are hard linked, anyway you are rigth sym link makes paths cleaner.

@zbeekman
Copy link
Contributor Author

merging #42 fixes this

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 a pull request may close this issue.

2 participants