euroscipy/euroscipy_proceedings

Instructions in README do not match those provided in the EuroSciPy email

riccardomurri opened this issue · 1 comments

The instructions provided in the front-page README do not match those
written in the email that was sent to EuroSciPy contributors.

The README states:

Here are the steps to produce a paper:

  • Fork the scipy_proceedings repository on GitHub.
  • An example paper is provided in papers/00_vanderwalt. Create a new directory papers/firstname_surname, copy the example paper into it, and modify to your liking.
  • Run ./make_paper.sh papers/firstname_surname to compile your paper to PDF (requires LaTeX, docutils, Python--see below). The output appears in output/firstname_surname/paper.pdf.

whereas the email says:

• Fork https://github.com/euroscipy/euroscipy_proceedings
• Clone the fork: git clone git@github.com:GITHUBLOGIN/euroscipy_proceedings
• Write your paper in papers/lastname.rst
• Commit and push it: git add papers/lastname.rst ; git commit -m "My paper" ; git push origin master

So in particular:

  • which repo should be cloned: euroscipy_proceedings or scipy_proceedings? (I assume the former.)
  • should the paper be papers/firstname_lastname/paper.rst or directly in papers/lastname.rst (the latter is not a good choice if a paper contains figures and external files)
  • should the produced PDF be committed to the repo as well?

Thanks for any clarification!

The README gives the steps to create your file and generate a pdf from the file. These instructions go along with the software that build the pdfs.

The email gives the procedure that are related to the submission itself.

The clarification would be: follow the email but replace "write your paper" by "follow the README" and fixing the few glitches (repo and file naming) in the process :-)

To reply to the specific points:

  • you should fork euroscipy/euroscipy/proceedings
  • the paper should be papers/lastname/lastname.rst (actually, the filename does not matter, but the directory name is important).
  • the pdf should not be committed.