You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-9
Original file line number
Diff line number
Diff line change
@@ -240,22 +240,24 @@ This repository captures all software projects to create a reproduction package,
240
240
241
241
### Create package
242
242
243
-
The creation of the reproducibility package consists of the following steps and is relies where possible on Makefile targets.
244
-
The package uses the remote images from Docker Hub at the time of creation
243
+
The creation of the reproducibility package consists of the following steps and relies on `Makefile` targets where possible (see brackets `(make ...)`).
244
+
The package uses the locally built images.
245
245
246
246
1. Clone the `reference-implementation` repository to an empty directory: `git clone https://github.com/o2r-project/reference-implementation.git`
247
-
1. Create the package with `make release`, which...
248
-
- cleans up potentially existing artifacts (`make local_clean`),
249
-
- prints software versions (`make versions`),
247
+
1. Create the package with `make package`, which...
248
+
- cleans up existing artifacts (`make package_clean local_clean`),
249
+
- prints _used_software versions (git, Docker etc., `make versions`),
250
250
- updates the nested projects (`make update`),
251
251
- builds all documentation locally (`make build_documentation`),
252
-
-save local version information of software and repositories to single file `versions.txt` (`make local_versions_save`),
252
+
-saves local version information of software and repositories to single file `versions.txt` (`make local_versions_save`),
253
253
- builds all images locally (see [limitations](#known-limitations), `make local_build`),
254
254
- saves the just built images into the file `o2r-reference-implementation-images.tar` (`make local_save_images`),
255
-
- saves all nested code repositories with their histories, to `o2r-reference-implementation-modules.zip`
256
-
- saves all nested documentation repositories with their histories, to `o2r-docs.zip`
255
+
- saves all nested repositories (including their histories)
256
+
- reference implementation software to `o2r-reference-implementation-modules.zip`
257
+
- documentation to `o2r-docs.zip`
258
+
- reproduction package files (everything except `README` files and `Makefile`) to `o2r-reference-implementation-files.zip`
257
259
1. Create a new deposit or a new version of the existing deposit on Zenodo
258
-
1. Upload the _small files_ to [Zenodo deposit](https://zenodo.org/api/deposit/depositions/2203844): `ZENODO_DEPOSIT_ID=2203844 ZENODO_ACCESS_TOKEN=xxxxxx make upload_files_to_zenodo` (the used Python scripts needs the module `humanfriendly`)
260
+
1. Upload the _small files_ to the just created Zenodo deposit ([first version](https://zenodo.org/api/deposit/depositions/2203844), the used Python scripts needs the module `humanfriendly`; `ZENODO_DEPOSIT_ID=xxxxxx ZENODO_ACCESS_TOKEN=xxxxxx make upload_files_to_zenodo`)
259
261
1. Manually upload the _big file_ to Zenodo deposit ([Zenodo API currently has a 100 MB file limit](http://developers.zenodo.org/#deposition-files))
260
262
1. Fill out metadata form on Zenodo and publish using the "Publish" button
0 commit comments