Difference between revisions of "AIRLab Repository"

Revision as of 11:57, 2 March 2010

AIRLab is a repository containing all the software, hardware projects, thesis, and so on, developed in AIRLab.

Who & What

The repository is particularly addressed to students: they must deposit all the material produced for their thesis on the repository. This includes:

• Code (C/C++, Java, Matlab, ...)
• Hardware projects (such as CAD drawings of mechanical parts, schematics, layouts, ...)
• Thesis source (tex, bibliography, pictures, ...)

The only exception consists in large data, such as big movies, datasets, and so on.

Becoming a member

AIRLab is based on svn; you can find some help in configuring Subversion in the Configuring Subversion page. The repository URL is https://svn.ws.dei.polimi.it/airlab/.

Students who need to work with AIRLab repository should fill the form at https://acme.ws.dei.polimi.it/request_account.plp with their info and put their supervisor in the "DEI responsible" field. They should then ask their supervisor to confirm their account (supervisors, here are the instructions for you).

Structure

This is a very brief overview of the directory hierarchy of the repository. The root may contain other directories beside the ones listed. Ignore them, if you don't know what they're about.

• Thesis: contains the thesis (text, code, and all the stuff listed above)
  • <SurnameName>-<student id> is the directory you must put your stuff in. You must create this directory.
    • README is a required plain text file that lists the content of the directory, with a brief description.

• Projects: contains bigger projects, usually carried on independently from BSc/MSc thesis.

Note: you must adhere to the exact format for your personal directory. The format is:

<Surname and name, in CamelCase http://en.wikipedia.org/wiki/CamelCase>-<6 digits student id>

Please avoid middle names and spaces.

Example: BottazziGiuseppe-123456

Rules

Beside what is stated above, please consider that:

• Binaries are built from source (don't commit binaries to the repository, unless it is strictly necessary). Exception: compiled latex code.
• Makefiles (and IDE project files) are part of the source code.
• Building instructions, if needed, must be written in a file called BUILDING.
• External libraries (OpenCV, ecc ecc) are NOT part of your code. Just list the libraries needed in a file called BUILDING. If the library needs some specific building switches, don't forget to list them in the file.
• Gerber files used for PCB production are different from layout files. Commit them.
• All the required and useful informations must be reported in a file called README.

On your personal wiki page please state your directory and list the content of your repository.

How to use AIRLab

The repository can be used in many different ways with many different tools.

• Command line client (svn)
• GUI clients (RapidSVN, kdesvn)
• IDE (eclipse with subversive plugin, for example)

For a kick start guide, you can read Version Control with Subversion.

Administration

Instructions for administration tasks can be found here: DEI Subversion Administration.