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

Ziu1986 bash script #2

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

ziu1986
Copy link
Member

@ziu1986 ziu1986 commented Mar 2, 2021

I have added a bash script which I wrote for my PhD thesis. It is not perfect, but it automates the command line compilation of latex documents. Including an automatic detection of the main document (the name can still be given by hand if that fails - typically if there are two files containing the \begin{document} identifier) conversion of svg and eps vector graphics into pdf format, cleaning up the directory from latex compilation files, compressing the document for publishing in pdf-a... if this PR is accepted the README has to be updated accordingly.

…ludes conversion of vectorgraphics svg/eps into pdf, cleaning up the directory from latex compilation files, compressing the document for publication in pdf-a format. Potential to make the script cleaner.
@sunnivin sunnivin requested a review from sarambl March 3, 2021 13:31
@sunnivin
Copy link

sunnivin commented Mar 3, 2021

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

Copy link
Member

@sarambl sarambl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks nice! But I think we need something in the README.md, cause I would have no idea how it works from this.
Also, there's a figure that uses the figure/ship_trackc.jpg which would be broken now due to the rename of the folder

@ziu1986
Copy link
Member Author

ziu1986 commented Mar 3, 2021

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

I currently have no time to add that the usage functionality - actually should have taken the time waaaaaaay back.

@sunnivin
Copy link

sunnivin commented Mar 3, 2021

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

I currently have no time to add that the usage functionality - actually should have taken the time waaaaaaay back.

Sorry to say this, but if you do not explain how to use your own code how can we know how it works? I do not expect 3 pages of explanations, but we do need a short introduction about how to use the script in the terminal :)

@ziu1986
Copy link
Member Author

ziu1986 commented Mar 3, 2021

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

I currently have no time to add that the usage functionality - actually should have taken the time waaaaaaay back.

Sorry to say this, but if you do not explain how to use your own code how can we know how it works? I do not expect 3 pages of explanations, but we do need a short introduction about how to use the script in the terminal :)

I was referring to the necessary change in bash script to include the usage function not description in the README. ;-)

@sunnivin
Copy link

sunnivin commented Mar 3, 2021

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

I currently have no time to add that the usage functionality - actually should have taken the time waaaaaaay back.

Sorry to say this, but if you do not explain how to use your own code how can we know how it works? I do not expect 3 pages of explanations, but we do need a short introduction about how to use the script in the terminal :)

I was referring to the necessary change in bash script to include the usage function not description in the README. ;-)

I see. Sorry, my bad:)

Still, I feel that you have to provide some explanations for how to use your script before we add it to the repo. It does not have to be long, but we do need something!

@sarambl
Copy link
Member

sarambl commented Mar 3, 2021

Aw

@ziu1986 : Thank you for the bash-script set-up! I also agree that it should be added a usage section to the README.md file that explains how this script should be used. Would you care to add these kinds of changes to your PR as well?
(If it is not done together I fear that this is forgotten).

I currently have no time to add that the usage functionality - actually should have taken the time waaaaaaay back.

Sorry to say this, but if you do not explain how to use your own code how can we know how it works? I do not expect 3 pages of explanations, but we do need a short introduction about how to use the script in the terminal :)

I was referring to the necessary change in bash script to include the usage function not description in the README. ;-)

Awsome! I think a simple couple of lines on what the script does and a

how-to-run-it-in-terminal

should suffice :)

Copy link
Member

@sarambl sarambl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I get to use the "request changes" option! Feeling like a true pro.
But would be awsome with something in the README.md

@ziu1986 ziu1986 requested a review from sarambl March 3, 2021 14:10
@ziu1986
Copy link
Member Author

ziu1986 commented Mar 3, 2021

@sarambl I have added some information to the README.

Copy link
Member

@sarambl sarambl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice :)

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 this pull request may close these issues.

3 participants