Make Usage section a bit more straight-forward. #278
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aminmkhan
suggested changes
Aug 3, 2019
README.md
Outdated
| @@ -83,14 +83,14 @@ You can [install TeX from upstream](http://tex.stackexchange.com/q/1092) (recomm | |||
|
|
|||
| #### Usage | |||
|
|
|||
| At a command prompt, run | |||
| At a command prompt, run (note that ``$`` is shell prompt) | |||
README.md
Outdated
|
|
||
| ```bash | ||
| $ xelatex {your-cv}.tex | ||
| $ cd examples/ | ||
| $ xelatex cv.tex |
There was a problem hiding this comment.
Just adding cd examples could be useful.
$ cd examples
$ xelatex {your-cv}.tex| ``` | ||
|
|
||
| This should result in the creation of ``{your-cv}.pdf`` | ||
|
|
|
Sorry about the late commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Hi,
Thanks for this repo.
I'm a newbie of LaTeX, it takes me a few minutes to figure out that
xelatex {your-cv}.texin README means to compile it withcv.texorresume.texinexamples/dir.At first I think it's ok to run with every single .tex files there, which of course leads to compilation errors.
So I think it's better to take the exact file as an example in README.