Skip to content

Commit dd69f9d

Browse files
authored
Revise README for training environment clarity
Updated README to clarify the purpose of the training environment and revised instructions for contributing. Adjusted steps and links to reflect the new repository name.
1 parent 847899a commit dd69f9d

1 file changed

Lines changed: 13 additions & 14 deletions

File tree

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# cdisc-open-rules-training
2-
Contains rules and test data that can be processed by CORE
32

4-
**BEFORE CONTRIBUTING, MAKE SURE YOU HAVE GONE THROUGH THE CDISC VOLUNTEERING ONBOARDING PROCESS** \
5-
https://www.cdisc.org/volunteer
3+
**THIS IS THE TRAINING ENVIRONMENT FOR CDISC OPEN RULES AUTHORING**\
4+
Contains rules and test data used for training purposes only. None of the actions done in this environment will be used officially. This is environment has been created to test get hands-on experience with the system and the rules. If you wish to contribute to the official CDISC Open Rules authoring: https://github.com/cdisc-org/cdisc-open-rules then make sure that you have gone through the CDISC volunteerinf onboarding process: https://www.cdisc.org/volunteer
65

7-
**SUPPLEMENTARY GUIDE** \
6+
**RULE AUTHORING PROCESS USING Git & VSCode** \
87
Instructions below will guide you step-by-step through the:
98
- First-time Local Setup Steps
109
- Rule Authoring and Test Data Creation Process
1110

11+
If you are less familiar with GitHub, Git and VSCode then you can access the supplementary guide which includes printscreens along with the instructions.
12+
1213
# First-time Local Setup Steps
1314

1415
***IMPORTANT NOTE*** \
1516
_You may need your IT support team to install some of the following software for you. In particular, the setup script requires python3.12 to run properly. If you don't have it installed, the script will attempt to install it for you, but this is likely to be blocked by your company settings. If so, you will need to contact IT._
1617

17-
**Follow steps 1 - 9 carefully.**
18+
**Follow steps 1 - 11 carefully.**
1819

1920
1) Create a free GitHub account: https://github.com/signup
2021
2) Install Git, following the instructions here: https://git-scm.com/install
@@ -24,9 +25,7 @@ _You may need your IT support team to install some of the following software for
2425
3) Install VSCode (***not*** VSCodeUser), following the instructions here: https://code.visualstudio.com/download
2526
4) Open VSCode and a terminal within it:
2627
- Top Menu → Terminal → New Terminal (check the three dots in the top menu if you don't see 'Terminal')
27-
5) Open VSCode and a terminal within it:
28-
- Top Menu → Terminal → New Terminal (check the three dots in the top menu if you don't see 'Terminal')
29-
- Configure your Git identity by running the following two commands in the terminal, replacing the placeholder values with your own:
28+
5) Configure your Git identity by running the following two commands in the terminal, replacing the placeholder values with your own:
3029

3130
`git config --global user.name "Your Name"`
3231

@@ -38,23 +37,23 @@ _You may need your IT support team to install some of the following software for
3837
- If any of the folder names you are navigating through have spaces (eg 'My Folder'), you will need to wrap the path in quotes,\
3938
eg: `cd "C:\Users\sam\Documents\Rules Folder"`
4039
7) Clone this repo into that directory by running the following command (**DO NOT RUN MORE THAN ONCE**): \
41-
`git clone --recurse-submodules https://github.com/cdisc-org/cdisc-open-rules.git`
40+
`git clone --recurse-submodules https://github.com/cdisc-org/cdisc-open-rules-training.git`
4241
> **NOTE:** If you encounter `The term 'git' is not recognized as the name of a cmdlet, function, script file, or operable program.`, Git's installation directory has not been added to your system PATH. See [this StackOverflow answer](https://stackoverflow.com/questions/4492979/error-git-is-not-recognized-as-an-internal-or-external-command) for instructions on manually adding Git to your PATH.
4342
4443
_***IMPORTANT NOTE***\
4544
Unless something goes badly wrong and you need to fully delete the entire directory, you should never need to run this command again._
4645

47-
8) In VSCode, select "Open Folder" and select the repository folder you just cloned - it should be called `cdisc-open-rules`
46+
8) In VSCode, select "Open Folder" and select the repository folder you just cloned - it should be called `cdisc-open-rules-training`
4847
- VSCode may show a prompt asking if you trust the authors of the files in this folder — click **Yes, I trust the authors**
4948
- You should also see a prompt to install the workspace recommended extensions in the bottom right corner — click **Install All**. If you miss this prompt, don't worry — step 10 will cover it
5049

5150
9) This should re-open a new terminal in the repository folder. If this doesn't happen, open a new terminal in VSCode and navigate to the repository folder again.
5251

5352
10) You will need to setup the python environment, which will take a little bit of time.
54-
- Assuming you are in the cdisc-open-rules folder in the VSCode terminal, run one of the following depending on your operating system (ignore messages and warnings):
55-
- WINDOWS: `.\setup\windows_setup.bat`
56-
- MAC: `./setup/bash_setup.sh`
57-
- Windows might prompt you asking if you want to install python - the answer is yes!
53+
- Assuming you are in the cdisc-open-rules folder in the VSCode terminal, run one of the following depending on your operating system (ignore messages and warnings):
54+
- WINDOWS: `.\setup\windows_setup.bat`
55+
- MAC: `./setup/bash_setup.sh`
56+
- Windows might prompt you asking if you want to install python - the answer is yes!
5857

5958
_***IMPORTANT NOTE***\
6059
If you start the setup script and stop it midway through, you may get some strange errors when you try to run rules in the future. If you have any doubts, rerun the setup script, and make sure it completes._

0 commit comments

Comments
 (0)