This topic describes how to get started with CCI Code.
The CCI Code source tree includes a link to CCI Metadata, so there is no need to obtain CCI Metadata separately if you use the an SVN client.
Enlist in the CCI Code Project
Enlist in the project as follows:
- If you have not done so already, obtain a CodePlex user name and password. To do so, go the
CodePlex home page and click the Register link at the top of the page.
- Install a source control client. This procedure assumes that you are using
TortoiseSVN Subversion client, but you can also use one of the clients listed later in this section. The basic procedure is similar for all clients.
- On the Source Code tab, click the appropriate link under Source Control Setup to display a dialog box with enlistment information.
- Copy the information from the dialog box and use it to enlist in the project. For TortoiseSVN, copy the URL from dialog box (https://cciast.svn.codeplex.com/svn) and use the URL and your CodePlex user name and password to enlist in the project. See the
TortoiseSVN documentation for details on how to enlist in a project.
- Check out the CCI Code source tree, as described in the TortoiseSVN documentation.
TortoiseSVN uses a checkout/commit model, so checking out the source tree simply copies the files to your hard drive. You can then use the source code as you choose. To modify the parent source tree, you must explicitly commit your changes.
The source tree’s root folder has several subfolders. The key ones are:
- Documentation: contains an API reference help file.
- Metadata: contains the CCI Metadata source tree.
- Samples: contains the source code for the basic samples.
- Sources: contains the source code for the CCI Code libraries.
- Tests: contains the source code for the test applications.
Other Source Control Clients
You can also enlist by using one of the following Visual Studio Team Foundation Server clients. Click the appropriate link for download information. See the client’s documentation for details on how to enlist in a project.
Anyone can use TortoiseSVN or CodePlex Client to synchronize with the CCI Code source tree. You must be a team member to use Visual Studio Team Explorer or Teamprise Explorer.
Build the Libraries and Samples
The CCI Code source tree is a Visual Studio 2008 solution that includes projects for each library and for a set of basic samples. To build the solution:
- Go to the source tree’s root folder.
- Open the solution, Metadata.sln, in Visual Studio.
- On the Build menu, click Build Solution to build the libraries and samples.
To use the CCI Code libraries in a solution that belongs to another CodePlex project or another Subversion repository:
- Use the svn:external property to set up a link between the two repositories
- Add the relevant CCI projects to your solution.
Build the API Reference
The source tree’s Documents subfolder includes an HTML Help File (CHM), CCI_Code.chm, which contains a complete API reference. However, CCI_Code.chm is not routinely built and might not be completely up to date. You can build a CHM which is synchronized with
the current sources, as follows:
- Install SandCastle Help File Builder.
- In the Documents folder, double-click the documentation project folder, Ast.shfbproj, which loads the project into SandCastle Help File Builder.
- In SandCastle Help File Builder, click the toolbar’s Compile button. This builds the CHM and places it in the Documents folder.
Contribute to CCI Code
To contribute to CCI Code, see
How to Contribute