Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
grudelsud committed Jan 7, 2014
0 parents commit 1bfad96
Show file tree
Hide file tree
Showing 9 changed files with 116 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Instructions

The template you forked is the basis for your code repository on DevArt.

This repository is where you will configure your Project page on DevArt site. It is also where you will build your code and document your process. Your page on DevArt will change every time you make changes to your code and push this repository to GitHub. All submissions in GitHub will need to be entered in English.

Your Project page on DevArt is made up of three parts:

**1. Project Description**

**2. Project Technologies**

**3. Project Posts**

All updates are made using [Github Flavoured Markdown Language](https://help.github.com/articles/github-flavored-markdown) language. Make sure your files use the GH Flavoured formatting.

## Updating your Project Page

### 1. Craft your Project Description
This is where you describe your project title, idea, vision and where the final results of your project are displayed. We encourage you to add images, videos, and links to final working versions of your project in this section. This can be edited as many times as you want. This will be the first thing judges will look at when they go to your Project page. The more complete, the better.

> Edit **project_description.md** with information about your project following the example provided in the file, commit and push your changes to GitHub and to update the description area of your Project page.
### 2. Enter your Project Technologies
This is where you define which technologies you use for your project. Make sure all technologies entered fit in either of the categories: ```LANGUAGES```, ```TOOLKITS```, ```API’S```,```PLATFORMS```. You can also add themes as tags (e.g: ```particles```, ```space```, ```dreams```). By creating a list of technologies, your project will be searchable and filtered by the different categories in the gallery.


> Edit **project_technologies.json** using with the example JSON structure, commit and push your changes to GitHub to update the project technologies. Make sure your JSON conforms to the structure of the template and is validated.

### 3. Update your Project Posts
This section is like a blog of your progress. This is where you will document your process—from early napkin sketches to versions of prototypes to the finished project. As soon as you have a rough idea of your project, you should create a Project Post. Your posts must show your progress as they will be viewed by the judges and taken into consideration during the judging process. On each post you can add a title, description, images and any other process documentation you find relevant using GitHub markdown.

> Locate the **project_posts/** folder, duplicate the example post using the same naming convention **YYYY-MM-DD-POST-TITLE.MD** updating the date, edit the post, commit and push your changes to GitHub. DevArt reads posts use the [Github Flavoured Markdown](https://help.github.com/articles/github-flavored-markdown) format, so make sure you are naming them correctly and using the GitHub markdown.
## Start early and post often
DevArt is as much about the process as it is about the finished piece. Again, judges will be taking your updates into consideration during the judging process. Make sure your updates have media content, including images (screenshots of your project, or pictures of sketches) and videos of prototypes and work in progress.

## Your final submission
Your final submission is your full Project Page with three sections: Project Description, Project Posts and Project Technologies. The Project Page is what will be judged by the judges. Read the judging criteria on the Enter Now page on the DevArt site.

Please double-check to make sure:

1. Your Project Description section includes your project name, a detailed description of your work and supporting images and videos. If possible, include a link to a working version of your project.
2. Your Project Technologies includes keywords for all themes explored and technologies used for your project.
3. You have at least 5 Project Posts demonstrating your progress, including one or more images and description for each post.

Empty file added build/.gitinclude
Empty file.
33 changes: 33 additions & 0 deletions project_description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Project Title
Name of your project

## Authors
- Main author name, surname, github account
- Other author(s) name, surname, github account (one per list element)

## Description
The abstract should contain about 100 to 150 words. It should include your vision, idea and execution. All manuscripts must be in English.

## Link to Prototype
If your project lives online you can add one or more links here. Make sure you have a stable version of your project running before linking it.

[Example link to Devart](https://devart.withgoogle.com "Devart")

## Example Code
Wrap your code blocks or any code citation by using ``` like the example below.
```
function test() {
console.log("Printing a test");
}
```
## Links to External Libraries
You can also use this space to link to external libraries or Github repositories you used on your project.

[Example link to Devart site](https://devart.withgoogle.com "Devart")

## Images
To add images you can either use a relative link to an image on this repo or an absolute link to an externally hosted image.

![Devart](project_images/logo.png?raw=true "Google Devart Logo")
![Doodle](http://www.google.com/logos/2012/haring-12-hp.png "Google Doodle")

Empty file added project_images/.gitinclude
Empty file.
Binary file added project_images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added project_posts/.gitinclude
Empty file.
4 changes: 4 additions & 0 deletions project_posts/2014-01-31-my-first-post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# This is my first text post!

You'll find this post in your `project_posts` directory - edit this post and push it to Devart to see your changes.
To add new posts, simply add a file in the `project_posts` directory that follows the convention: `YYYY-MM-DD-title-of-post.md`.
11 changes: 11 additions & 0 deletions project_posts/2014-02-01-post-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# This is the title of a post with images and videos

This is the example of how you can add images to your project. Remember that the image source link can refer either to an image hosted on the repository:

![Devart](../project_images/logo.png?raw=true "Google Devart Logo")

or to an externally hosted image:

![Alt text](http://www.creativeapplications.net/wp-content/uploads/2013/11/kinematics_nervous_system_01-copy.jpg "Image Title Text")

You can also embed videos from Youtube: just add a link to a video and DevArt will take care of showing it in the post: http://www.youtube.com/watch?v=oz5lYp6XauA
21 changes: 21 additions & 0 deletions project_technologies.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"technologies": {
"apis": [
"insert api",
"insert api"
],
"platforms": [
"insert platform",
"insert platform"
],
"toolkits": [
"insert toolkit",
"insert toolkit"
]
},
"themes": [
"insert theme",
"insert theme"
]
}

0 comments on commit 1bfad96

Please sign in to comment.