Spatial Computing Project Template

This is a project template for Spatial Computing Students. Students shall fork this repository and use it as the basis of their project. Mid-term and Final submission is expected through pull GitHub.

Folder Structure

The folders in student projects should strictly follow the structure of the folders in this repository. The main folders are four assignment folder (corresponding to each assignment) and one folder for final deliverables of your project. In general, the process sub-folders include all the necessary code, notebook, files, and models that you have used to achieve the final product of that assignment. It also includes document that represent the process of the assignment such as flowcharts, diagrams and pseudo-codes. The product sub-folder sh

Here is run down of the overall structure:

• A1_Planning
  • Process
  • Product
• A2_Configuring
  • Process
  • Product
• A3_Massing
  • Process
  • Product
• A4_Forming
  • Process
  • Product
• Final_Deliverables

  Here you will include all the final deliverables of your project.

• docs

  Here you will write and edit the source of your documentation in MarkDown. An example is included in the template to help you begin documenting your project.

• site

  you should leave this directory empty. It will be filled by automatic documentation generator MkDocs

Guidelines

• File Size: No file bigger than 50mb is recommended. No file bigger than 100mb is allowed.
• Duplicates: Do NOT include duplicates in your files.
• Naming Convention: Avoid using special characters or spaces in file and folder names. Instead, use "_" to separate words in the names.
• Video and Animation files should not be included the repository. They should be uploaded to online video services (YouTube, Vimeo, etc). You should embed those video link in your documentation. (GIF files are allowed in your repo)
• Geometric Models (.3dm, .obj, etc) should be compressed before being added to repository.