From f8d1b2d021b7e3bab9f8c47818d5a34224ce87c6 Mon Sep 17 00:00:00 2001 From: andreaschrader <85687301+andreaschrader@users.noreply.github.com> Date: Mon, 21 Aug 2023 11:21:53 +0200 Subject: [PATCH] Added some more links to files and some additiona descriptions to the README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1ac0b1b..a2996b2 100644 --- a/README.md +++ b/README.md @@ -88,13 +88,14 @@ Term Source Description | Experimental Factor Ontology | Scholarly Contributions ### Adding a second publication -As above but ontology reference information do not need to be entered in duplicates. +Not done in this example. +(As above but ontology reference information do not need to be entered in duplicates.) ## Connect the ARC with the HUB Connect the local ARC with the HUB "project" and sync changes -- Prepare a TOKENSTRING (personal access token (e.g. like here: https://github.com/nfdi4plants/arcCommander/discussions/157)) +- prepare a TOKENSTRING (personal access token (e.g. like here: https://github.com/nfdi4plants/arcCommander/discussions/157)) - replace TOKENSTRING,YourGitLabNAME and ARC_NAME below ```bash @@ -103,11 +104,11 @@ arc sync -r https://oauth2:TOKENSTRING@git.nfdi4plants.org/YourGitLabNAME/ARC_NA ## Add a README, a LICENCE and a .gitignore file -Here: A template README has been added here as TEMPLATE_README.md. +Here: A template README has been added here as [TEMPLATE_README.md](./TEMPLATE_README.md). > When this is used, it needs to be named "README.md". -Here: A CC-BY 4.0 license has been added. -Here: An initial .gitignore file has been added with the entry ".DS_Store" for macOS. +Here: A [CC-BY 4.0 license](./LICENSE) has been added. +Here: An initial [.gitignore file](./.gitignore) has been added with the entry ".DS_Store" for macOS. ### Sync with the HUB @@ -115,12 +116,14 @@ Here: An initial .gitignore file has been added with the entry ".DS_Store" for m arc sync -m "Added a README template, .gitignore for macOS and a CC-BY 4.0 licence file." ``` -## Only for this Grow-an-ARC_Example - add the README.md which contains the procedure described here. +## Only for this Grow-an-ARC_Example - add the README.md which contains the procedure described here... ```bash touch README.md ``` +... and, of course, synchronize again with a message explaining what has been changed. + ```bash arc sync -m "Added the README for this Grow-an-ARC_Example ARC including the process of growing this ARC." ``` \ No newline at end of file -- GitLab