diff options
Diffstat (limited to 'README-hacking.md')
| -rw-r--r-- | README-hacking.md | 50 |
1 files changed, 38 insertions, 12 deletions
diff --git a/README-hacking.md b/README-hacking.md index 554ba6b..a598373 100644 --- a/README-hacking.md +++ b/README-hacking.md @@ -173,10 +173,21 @@ Published works using Maneage ----------------------------- The list below shows some of the works that have already been published -with (earlier versions of) Maneage. Previously it was simply called -"Reproducible paper template". Note that Maneage is evolving, so some -details may be different in them. The more recent ones can be used as a -good working example. +with (earlier versions of) Maneage, and some that have been recently +submitted for peer review. The previous version of Maneage was called +"Reproducible paper template", with a separate git tree. Maneage is +evolving rapidly, so some details will differ between the different +versions. The more recent papers will tend to be the most useful as good +working examples. + + - Roukema ([2020](https://arxiv.org/abs/2007.11779), + arXiv:2007.11779): The live version of the controlled source is [at + Codeberg](https://codeberg.org/boud/subpoisson); the main input + dataset, a software snapshot, the software tarballs, the project + outputs and editing history are available at + [zenodo.3951152](https://zenodo.org/record/3951152); and the + archived git history is also available at + [swh:1:dir:fcc9d6b111e319e51af88502fe6b233dc78d5166](https://archive.softwareheritage.org/swh:1:dir:fcc9d6b111e319e51af88502fe6b233dc78d5166). - Akhlaghi et al. ([2020](https://arxiv.org/abs/2006.03018), arXiv:2006.03018): The project's version controlled source is [on @@ -678,7 +689,7 @@ First custom commit $ ./project make ``` - 7. **Ingore changes in some Maneage files**: One of the main advantages of + 7. **Ignore changes in some Maneage files**: One of the main advantages of Maneage is that you can later update your infra-structure by merging your `master` branch with the `maneage` branch. This is good for many low-level features that you will likely never modify yourself. But it @@ -929,23 +940,29 @@ future. - **Reserve a DOI for your dataset**: There are multiple data servers that give this functionality, one of the most well known and (currently!) well-funded is [Zenodo](https://zenodo.org) so we'll focus on it - here. Ofcourse, you can use any other service that provides a similar + here. Of course, you can use any other service that provides a similar functionality. Once you complete these steps, you can start using/citing your dataset's DOI in the source of your project to finalize the rest of - the points. Note that with Zenodo, you can even use the given identifier + the points. With Zenodo, you can even use the given identifier for things like downloading. - * *Start new upload*: After you log-in to Zenodo, you can start a new + * *Start new upload*: After you log in to Zenodo, you can start a new upload by clicking on the "New Upload button". * *Reserve DOI*: Under the "Basic information" --> "Digital Object Identifier", click on the "Reserve DOI" button. - * *Fill basic info*: You need to atleast fill the "required fields" - (marked with a red star). + * *Fill basic info*: You need to at least fill in the "required fields" + (marked with a red star). You will always be able to change any + metadata (even after you "Publish"), so don't worry too much about + values in the fields, at this phase, its just important that they + are not empty. - * *Save your upload*: You should now be able to press the "Save" button - (at the top or bottom of the page) to finalize this step. + * *Save your project but do not yet publish*: Press the "Save" button + (at the top or bottom of the page). Do not yet press "Publish" + though, since that would make the project public, and freeze the DOI + with any possible file you may have uploaded already. We will get to + the publication phase in the next steps. - **Request archival on SoftwareHeritage**: [Software Heritage](https://archive.softwareheritage.org/save/) is an online @@ -1170,6 +1187,15 @@ future. are public). If not, you can mention that everything is ready for such a submission after acceptance. + - **Future versions**: Both Zenodo and arXiv allow uploading new versions + after your first publication. So it is recommended to put more recent + versions of your published projects later (for example after applying + the changes suggested by the referee). In Zenodo (unlike arXiv), you + only need to publish a new version if the uploaded files have + changed. You can always update the project's metadata with no effect on + the DOI (so you don't need to upload a new version if you just want to + update the metadata). + |