- Install SSH

Download and unzip SSH.zip to your own folder such as C:\. For Hank group members, if you don't want to enter a password every time you do any CVS action, you can get a digital key by contacting hank@cs.uiowa.edu .

- Set environment variable-"HOME"

For example, set HOME=C:/SSH

Checkout steps

Now we use the module - Hank as an example to show the checkout steps. This module contains the source code for Hank simulator.

1. Configure CVSROOT data

Open WinCvs window.  Choose menu item Admin->Preferences and fill the options in the window below.  You may choose another host address as long as it is valid, such as linux.cs.uiowa.edu.

If the file ssh.exe is not included in the value of environment variable PATH, click the Settings button and input the file location of ssh.exe like the following.

Click OK button. 

Click WinCVS tab.  Enter the directory where SSH public password is stored.

Click OK button.

2. Checkout settings

Choose menu item Create->Checkout Module.   Type in the module name- Hank and the local folder to which the module is checked out.

Note that all the checked out files will be read-only by default. If you want them to be unlocked, click Globals tab and uncheck the Checkout read-only box. You can also unlock each file after the checkout.

Currently, the module Hank has four branches: the main branch, the branch for experiments, and two branches for Hongling and Scott. By default, you will check out Hank from the main branch. If you want to get the code from another branch, specify the branch name through Checkout setting->Checkout options.

Click OK button.  Then all the files of Hank simulator are copied into your directory. If it is done correctly, there will a message in the output window saying

*****CVS exited normally with code 0***** 

Otherwise, there will be some error reported and the exit code will be 1 instead of 0. 

Now you are ready to edit and compile the source code for Hank simulator.

Checkouts of other modules

There are five other modules in Hank system. Their checkouts are very similar except that you do not have to specify a branch name since each one of them only has one branch for now.

Please note  

Since we want to keep a clean and reliable copy for people to do the checkout, please DO NOT commit your changes without the knowledge of other Hank group members. If you are going to add some new changes to the code, it is recommended that you work on a separate branch and your changes can be incorporated into the system by merging with the main branch. To create a branch, please contact zhihwang@cs.uiowa.edu .