Changes between Version 2 and Version 3 of Docs/Prog/Manual/Development/Setup

Timestamp:

11/30/09 15:12:19 (15 years ago)

Author:

Don Wilson

Comment:

--

Docs/Prog/Manual/Development/Setup

@@ -21 +21 @@
 [[Top]]
 
+[[PageOutline]]
+
+= Environment Setup =
+
+== About == 
+This document will discuss in detail how to setup your environment to program the Cardinal 825 Digital Weight Indicator.
+
+== Features of the Cardinal 825 Programming Environment ==
+ * Subversion integration for instant access to the latest source code.
+ * Full featured Eclipse IDE which is quickly becoming the standard for developers everywhere.
+ * Mylyn integration with the Cardinal 825 Tech site for quick access to tickets and progress.
+ * Full debugging capabilities (coming soon).
+
+== Required Files ==
+The following files should be included on the 8GB USB flash drive that was sent with your order.
+
+ * [http://www.vmware.com/products/player/ VMware Player] - Required to run the Cardinal Fedora 825 Programming Environment.
+ * Cardinal Fedora 11 825 programming package
+
+== Installing the Environment ==
+ 1. Insert the 8GB USB flash drive into your computer.
+ 2. Install VMware Player by double clicking on the icon in the directory of the flash drive.
+ 3. Follow the steps listed choosing the default values to install.
+
+  [[Image(screenshot.1.jpg)]]
+  [[Image(screenshot.2.jpg)]]
+  [[Image(screenshot.3.jpg)]]
+  [[Image(screenshot.4.jpg)]]
+  [[Image(screenshot.5.jpg)]]
+  [[Image(screenshot.6.jpg)]]
+
+ 4. Reboot your computer if required.
+ 
+  [[Image(screenshot.7.jpg)]]
+
+ 5. Copy the Cardinal 825 Programming Environment package to your computer in any directory you wish.
+
+== Starting the Environment ==
+ 1. Start VMware Player by going to Start -> Programs -> VMware and choosing VMware Player
+
+  [[Image(screenshot.9.jpg)]]
+
+ 2. Start the Cardinal 825 Programming Environment by choosing Open and choosing the '''Cardinal 825 Programming Environment.vmx''' file from the directory you extracted it to in "Installing the Environment step 5".
+
+  [[Image(screenshot.10.jpg)]]
+  [[Image(screenshot.11.jpg)]]
+
+ 3. VMware will start.
+
+  [[Image(screenshot.12.jpg)]]
+
+ 4. Press '''Take Ownership''' when the prompt appears.
+
+  [[Image(screenshot.13.jpg)]]
+
+ 5. If this error appears press '''No'''.
+
+  [[Image(screenshot.14.jpg)]]
+
+ 6. VMware will power up Fedora Core 11.
+
+  [[Image(screenshot.15.jpg)]]
+
+ 7. Login by clicking on '''user''', entering password '''123456''' and clicking '''Login'''.
+
+  [[Image(screenshot.16.jpg)]]
+  [[Image(screenshot.17.jpg)]]
+
+ 8. The Cardinal 825 Programming Environment will start automatically.
+
+  [[Image(screenshot.18.jpg)]]
+
+== Using the Environment ==
+
+=== Welcome Screen ===
+The welcome screen gives you basic information about the Eclipse IDE. You can choose to view the information by clicking on the individual images or simply close it by pressing the X button in the corner.
+
+  [[Image(screenshot.29.jpg)]]
+
+=== Project Explorer ===
+The project explorer gives you an overview of projects that are in your workspace. The Cardinal 825 Programming Environment is set to use /home/user/Workspace as the default workspace. You can change this by selecting File > Switch Workspace.
+
+  [[Image(screenshot.19.jpg)]]
+
+On the initial startup you will notice eight projects which have been preloaded for you.
+  * chkwgh - Checkweigher
+  * dfc - DFC Batcher
+  * HelloWorld - Tutorial application
+  * ids - Truck / ID Storage
+  * lib825 - 825 library
+  * libapp - application library
+  * libsql - SQL database library
+  * mscale - Multi-scale
+
+=== Task Repositories ===
+Task repositories list the available bug tracking repositories. The Cardinal 825 Trac repository has been setup for you but you will need to enter your individual username and password for the Trac site (the one you used to login to the Wiki).
+
+  [[Image(screenshot.20.jpg)]]
+
+  1. Right-click on '''Cardinal 825 Trac''' and choose '''Properties'''.
+
+  [[Image(screenshot.21.jpg)]]
+
+  2. Uncheck anonymous and enter your validation credentials. When you are finished, press Validate Settings in the bottom-left. 
+
+  [[Image(screenshot.22.jpg)]]
+  [[Image(screenshot.23.jpg)]]
+
+  3. If you receive no errors you can press the "Save Password" checkbox and press Finish to save the settings.
+
+=== Task Queries ===
+Task queries allows you to generate custom queries to view tickets for the Cardinal 825.
+
+  1. Right click on the '''Cardinal 825 Trac''' repository and choose '''New Query...'''.
+
+  [[Image(screenshot.24.jpg)]]
+
+  2. We're going to create a query that will show all open tickets for the 825. Enter the information as shown in the screenshot and for '''Status''' choose all available except for closed. Press finish when you are done.
+
+  [[Image(screenshot.33.jpg)]]
+
+  3. A notification will appear to show you new tickets are available. This works fine but if you are forgetful like me you need a more permanent solution.
+
+  [[Image(screenshot.25.jpg)]]
+
+  4. Choose Window -> Show View -> Other...
+
+  [[Image(screenshot.27.jpg)]]
+
+  5. Choose '''Task List''' from the '''Tasks''' folder and press OK.
+
+  [[Image(screenshot.34.jpg)]]
+
+  6. Task List will now display on the bottom pane. Let's click and drag it next to the Task Repositories on the top-left.
+
+  [[Image(screenshot.30.jpg)]]
+  [[Image(screenshot.31.jpg)]]
+
+  7. You will now have two categories. One is '''Uncategorized''' which is all tickets that we do not have a query for. The other is named '''*''' which is the query we just created. That's not a very intuitive name so let's rename it. Right-click on the '''*''' and choose rename. Enter '''All Tickets''' and press enter.
+
+  [[Image(screenshot.32.jpg)]]
+
+=== Subversion ===
+Every project distributed with the Cardinal 825 Programming Environment comes ''attached'' to a Subversion repository. Subversion repositories allow you to get the most up to date source code with the click of a button.
+  1. Right-click on the HelloWorld project and choose Team -> Update.
+
+  [[Image(screenshot.35.jpg)]]
+
+  2. You now have the latest available source code for the HelloWorld project.
+
+Cardinal recommends creating your own repositories for your projects. For more information on doing so please see [http://www.google.com/search?rlz=1C1GGLS_enUS313US313&sourceid=chrome&ie=UTF-8&q=subversion+guide Google's Listing on Subversion Guides].