Changes between Version 35 and Version 36 of DEVELOPMENT_OVERVIEW


Ignore:
Timestamp:
11/26/08 21:39:10 (17 years ago)
Author:
kyli
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • DEVELOPMENT_OVERVIEW

    v35 v36  
    44= 0. The Setup = 
    55This is a step-by-step tutorial for installing the development tools, used during Sophie2 development. [[BR]] 
     6 
    67'''Accounts creation'''. In order to communicate with the team members, you must create the following accounts: 
    7  * Google groups: [http://groups.google.com/group/sophie2-devs Developers Mail Group], [http://groups.google.com/group/sophie2-users Users Mail Group]. You must have a gmail account to apply for a mambership. 
    8  * Skype account: provide it to our Human Resource Manager and you will be included in the group chat. 
    9  * SVN/Trac accounts: ask someone from the team for these.[[BR]] 
    10 '''Workstation setup'''. Every machine in the office should have at least '''two users''': one for private usage (you choose your username and password) and one for public usage(ask a team member for the username and password). A '''text editor''' is neccesary (for example, Notepad++, you can download it from [http://notepad-plus.sourceforge.net/uk/site.htm]). Other important software: '''web browser''', '''PDF reader''', '''Flash player''', '''Skype''', '''Sophie''' ([http://opensophie.org/en/downloads]).[[BR]] 
     8  * Google groups: [http://groups.google.com/group/sophie2-devs Developers Mail Group], [http://groups.google.com/group/sophie2-users Users Mail Group]. You must have a gmail account to apply for a mambership. 
     9  * Skype account: provide it to our Human Resource Manager and you will be included in the group chat. 
     10  * SVN/Trac accounts: ask someone from the team for these.[[BR]] 
     11 
     12'''Workstation setup'''. Every machine in the office should have at least ''two users'': one for private usage (you choose your username and password) and one for public usage(ask a team member for the username and password). A ''text editor'' is neccesary (for example, Notepad++, you can download it from [http://notepad-plus.sourceforge.net/uk/site.htm]). Other important software: ''web browser'', ''PDF reader'', ''Flash player'', ''Skype'',  
     13''Sophie'' ([http://opensophie.org/en/downloads]).[[BR]] 
     14 
    1115'''SVN setup'''. Subversion (SVN) is the version control system that we use. On Windows you can use TortoiseSVN (download it from [http://tortoisesvn.net/download]). The official site of SVN is [http://subversion.tigris.org/]. There you can find SVN binaries for other OS-es. You must install the subversion client in order to continue to the next step, e.g.[[BR]] 
     16 
    1217'''Repository setup'''. Once you have installed SVN, you can download the repository on your own machine. Basically, this means you will have your copy of the project. In WIndows, just choose a folder on your drive, right click and select SVN Checkout. Further explanation for the repository links / structure / rules for commiting can be found at [wiki: PLATFORM_STANDARDS_REPOSITORY]. Just before you continue to the next step, you should know how to submit a file to the repository (for example, your daily report).[[BR]] 
    13181) Create the new file in the desired folder (for reports, it is /manage/reports/[current iteration]/. The format of reports is explained below, in the "Process" chapter). [[BR]]  
    … …  
    15203) Use "svn commit" to commit it. Attention: commiting without comment is NOT allowed! [[BR]] 
    1621A sample boook about subversion can be found at [http://svnbook.red-bean.com/].[[BR]] 
     22 
    1723'''JDK'''. Since Sophie2 is written in Java, it requires Java Development Kit (JDK) in order to delop it, and Java Runtime Environment to run it. JDK can e downloaded and installed from [http://java.sun.com]. [[BR]] 
     24 
    1825'''Maven setup'''. Maven is a software tool for Java project management and build automation. Downloads and installation  
    1926instructions are located at [http://maven.apache.org/download.html]. A tutotial for building with Maven is written here:  
    2027[wiki: PLATFORM_DEPLOYMENT_BUILD_MAVEN]. If you build the project with maven, you would probably need to open  
    2128[http://asteasolutions.net:7080/sophie2/browser/trunk/sophie2-platform/old/lib/readme.txt sophie2-platform/old/lib/readme.txt] and read the bottom lines. [[BR]] 
     29 
    2230'''Eclipse setup'''.  The software platform we use for developing Sophie2 is Eclipse. First of all, the intallation.  
    2331Download the latest eclipse version from [http://www.eclipse.org/downloads/] and install it to your computer. Then, modify your compiler esttings according to the [wiki: COMPILER_SETTINGS] document. The next two steps, subclipse installation and maven integation, are described in [wiki: PLATFORM_INFRASTRUCTURE_OVERVIEW#EclipsePlug-ins]. The most important for these is that they are eclipse plugins, which integrate the subversion and maven functionalities in Eclipse. The M2 plugin is required for loading our maven project in eclipse. Once you have installed the plugins, you can follow the steps from [wiki: PLATFORM_DEPLOYMENT_BUILD_ECLIPSE], which describes how to import Sophie2 in Eclipse and run the FakeAuthor configuration. [[BR]] 
    … …  
    2634= 1. The Project = 
    2735 '''The Goal'''. The most important part of a project is its goal. So, the goal of our project is to take the good aspects of Sophie and optimize them, as well as to remove the bad ones. [[BR]] 
     36 
    2837'''Schedule'''. The Sophie2 project is split into about 600 tasks, each with one or more revisions (totally, about 2000). These tasks have several states, and you will learn about them in the next chapter. The tasks are divided into 12 sprints (iterations), each sprint is about 1 month long. The methodology used for the schedule of the project is not exactly SCRUM, but is similar to it. For more information what SCRUM is, read [http://en.wikipedia.org/wiki/Scrum_(development)]. [[BR]] 
     38 
    2939'''Layers'''. Task names are also grouped in several development layers: 
    3040 * PLATFORM: specifies coding standards, platform structure, plugin structure, as well as tools for building the project. 
    … …  
    3646 * SUPPORTING_ARTIFACTS: te project schedule, the backlog and the process are categorized as supporting artifacts. 
    3747 * END_PRODUCT: here are a few tasks related to application tuning and making user help. [[BR]] 
     48 
    3849'''Additional'''. The non-development side of the project is described in the [wiki: PROJECT_OVERVIEW] document. There you can read some things about Astea, Sophie, the license we use, and other useful things. 
    3950