Closed kadrlica closed 7 years ago
Here is a full example of the commands that I used to start a paper in Overleaf:
# Get start_paper template
wget https://raw.githubusercontent.com/LSSTDESC/start_paper/master/deploy_from_github_zip.bash
bash ./deploy_from_github_zip.bash doc
# Need desc-tex to be public for this to work
#bash ./deploy_from_github_zip.bash doc/desc-tex LSSTDESC/desc-tex master
#(I installed desc-tex by hand for now)
cd doc
# Initialize the repo
git init
git add .
git commit -m "init repo"
# Add overleaf remote
git remote add overleaf https://git.overleaf.com/4551529zqsdhy
# Grab from overleaf
git checkout master
git pull overleaf master --allow-unrelated-histories -s ours
# Ignore overleaf changes
git revert --mainline 1 HEAD
# Push back to overleaf
git push overleaf master
Nice! I think your comment above should be included instead of (or in addition to) the list of "follow the instructions here" lines in the documentation.
Yeah, I was thinking they would be good to have on hand, though the seemed a bit detailed for the README. Do you have another suggestion where to put them?
Also, I'm not sure who is authorized to merge this PR, but I am not.
I can merge, apparently, although I can't give you the ability to do it yourself.
I think it would be acceptable to put it in the README. Alternatively, you could package it up as a stand-alone script, which might be useful.
Btw, can you clarify whether one needs to create a new empty project in Overleaf first? (I assume so, in order to get the address to push to.)
Yeah, you need to create a new project on Overleaf. That is Step 1 in the linked instructions: "1. Create a new project on Overleaf. You can do this from your My Projects dashboard. You might as well use the 'Blank' template, since we're going to overwrite it."
Right now the install "script" is more of a "gist" than something people could actually execute.
Sure. But it would take minimal effort to make it executable, in the spirit of deployfrom....bash.
The (actual) minimal effort solution I would suggest is dumping the code snippet into the README below your other additions, with an additional comment at the top about creating an empty overleaf project.
Ok, done.
Added instructions for starting a paper on Overleaf. Updated latexmkrc to agree with the new
desc-tex
structure.