https://wolfr.am/ss2017git

This is a sample repository for the Wolfram Summer School 2017 you can clone or fork this repository to get started

Thing to do to get started with GIT:

Create a GitHub account

https://github.com/join

Create a new repo

you can either create a new repo or fork this one

Give your instructor write permissions

you need to give write permission to that repo to your tutor and to @alisonkimball in instructors.csv you can find a list of all instructors.

Github	Tutor	Email
https://github.com/alisonkimball	Alison Kimball	[email protected]
https://github.com/anonymouse64	Ian Johnson	[email protected]
https://github.com/batracos	Giulio Alessandrini	[email protected]
https://github.com/bernate	Bernat Espigulé	[email protected]
https://github.com/carlobarbieri	Carlo Barbieri	[email protected]
https://github.com/digiflux	Vitaliy Kaurov	[email protected]
https://github.com/etiennebcp	Etienne Bernard	[email protected]
https://github.com/gerli	Gerli Jõgeva	[email protected]
https://github.com/jofregit	Jofre Espigule-Pons	[email protected]
https://github.com/KMDaily	Kevin Daily	[email protected]
https://github.com/KyleKeane	Kyle Keane	[email protected]
https://github.com/levantina	Valentina Biagini	[email protected]
https://github.com/maboyer	Mark Boyer	[email protected]
https://github.com/matteosal	Matteo Salvarezza	[email protected]
https://github.com/matthews-wri	Matthew Szudzik	[email protected]
https://github.com/paulcabbott	Paul Abbott	[email protected]
https://github.com/publicusrex	Peter Barendse	[email protected]
https://github.com/r-nachbar	Robert Nachbar	[email protected]
https://github.com/riccardodivirgilio	Riccardo Di Virgilio	[email protected]
https://github.com/timotheev	Timothee Verdier	[email protected]
https://github.com/turnmlz	Lizzie Turner	[email protected]
https://github.com/xavierrw	Xavier Roy	[email protected]

Download and install a Git UI

On OSX / Wndows:
Download and install github desktop:
https://desktop.github.com

On Ubuntu:
Download and install git kraken:
https://www.gitkraken.com
Login and authenticate with GitHub
https://support.gitkraken.com/integrations/github

Install command line utility (optional)

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

Clone the repo locally

by clicking on the button CLONE OR DOWNLOAD and then to OPEN IN DESKTOP

Write a readme using MarkDown

a nice cheatsheet can be found here: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet the readme should contain:

1. what your project is about
2. how to run your code
3. examples, code documentation, etc

Organize your code

in this repository you will find 2 different ways to organize your code, the simple way and the programmer way.

The simple way

you split your logic into functions that you need for your projects and notebooks that you use to visualize data and show final results.

1. the code is in starthere/simple.m
2. the notebook used for visualization is in starthere/simple.nb

The programmer way

I prepared a very simple project paclet you can use, it provides a way to organize your code and your data

1. the code is in paclet in starthere/Project folder
2. raw source data can be put in starthere/Project/Assets/ folder
3. the notebook used for visualization is in starthere/advanced.nb