diff --git a/README.md b/README.md index fd59d55..7dbfff9 100644 --- a/README.md +++ b/README.md @@ -23,28 +23,30 @@ package to Overleaf first: 1. Create a project locally. 2. Run `make` 3. Run `make source-pack` -4. Send the zip file to Filip Graliński and wait for the reply. -5. Copy project to some other place. -5. Clone the repo from Overleaf: `git clone https://git.overleaf.com/FUNNY-OVERLEAF-CODE PAPERID-paper` -6. Set remotes: +4. Check whether you have an account at http://filipg-jenkins.wmi.amu.edu.pl:8090, + if not, sign up there (see also http://filipg-jenkins.wmi.amu.edu.pl/Jenkins). +5. Send the zip file to Filip Graliński and wait for the reply. +6. Copy project to some other place. +7. Clone the repo from Overleaf: `git clone https://git.overleaf.com/FUNNY-OVERLEAF-CODE PAPERID-paper` +8. Set remotes: ``` git remote add overleaf https://git.overleaf.com/FUNNY-OVERLEAF-CODE git remote set-url origin git@git.wmi.amu.edu.pl:YOURID/YOUR-GITLAB-REPO ``` -7. Set credential helper so that stupid Overleaf won't ask about +8. Set credential helper so that stupid Overleaf won't ask about password: `git config credential.helper "cache --timeout=10000000"` -8. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip +9. Unfortunately, Overleaf will discard hidden files (`.*`) when a zip is uploaded, also file permissions will be somewhat broken (did I tell you how much I hate Overleaf?) -9. … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`) -10. Re-commit the files (including recovered `.*` files). -11. Push the repo to Overleaf (fortunately, the `.*` will be treated +10. … so you need to copy `.cookiecutter.yml` file and re-apply the template (`cookiecutter https://git.wmi.amu.edu.pl/filipg/cookiecutter-amu-thesis.git --checkout VERSION --output-dir .. --config-file .cookiecutter.yml --no-input --overwrite-if-exists`) +11. Re-commit the files (including recovered `.*` files). +12. Push the repo to Overleaf (fortunately, the `.*` will be treated correctly when this is done by git): `git push overleaf master` -12. Push the repo to GitLab. `git push origin master` -13. Set the Overleaf git remote in `helpers/vars` -14. Now you can synchronize between GitLab repo and Overleaf manually or using `helpers/synchro.sh` script +13. Push the repo to GitLab. `git push origin master` +14. Set the Overleaf git remote in `helpers/vars` +15. Now you can synchronize between GitLab repo and Overleaf manually or using `helpers/synchro.sh` script Updating package with updated template --------------------------------------