-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
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
Add note for symbolic links on Windows #392
Conversation
Hi, thanks, I assume this is in relation to #21 - does this actually fix the problem though?
I don't think setting this to true (after cloning? Otherwise it would just be overridden?) is going to make symlinks magically work on Windows? I'm inclined not to address this at all, since it's just a general gotcha to be aware of for git users on Windows, not something Awesome-CV specific. The 'How to use' section in the readme already suggests a docker image (where the symlink should work fine) and the non-docker option says nothing about the examples, just referencing an hypothetical 'your-cv.tex'; there's really no need for a Windows user (using Awesome-CV for their own CV) to use git or symlinks. (Developing Awesome-CV from Windows is another matter, but that's where IMO 'you're a git user and a Windows user, you figure it out' comes in. Some suggestions here: https://stackoverflow.com/questions/5917249/git-symlinks-in-windows) |
My recommendation is add the note for Windows user set the configuration before clone the repository
The Docker option in Windows no work if your clone the repository without symlinks |
But it sounds like it will be overridden by
It should if you clone inside the container. |
Before cloning the repository, the git configuration can be read on a per-user basis if you use |
While a reduction of the LaTeX specific questions or system configuration specific questions that pop up in issues might not be a bad thing, it would require an encyclopedic readme. I can't comment on whether this actually fixes the problem or not, but I think this specific advice in the readme is not necessary because:
This doesn't mean people haven't asked and had the question answered before, see #21. Similarly, information about underling or italicizing particular words wouldn't go in the readme for a similar reason: it is a general thing about LaTeX to be aware of not something specific to Awesome-CV. That doesn't mean people haven't asked, see #347. A disclaimer that The issues referenced above are for illustrative purposes only. I appreciate the many people who have contributed helpful answers about LaTeX in response to questions posed and hope the approachable nature of Awesome-CVs Issues page has encouraged people to continue learning and using LaTeX. |
No description provided.