diff --git a/Contributions/Notebook Archive/readme.md b/Contributions/Notebook Archive/readme.md new file mode 100644 index 00000000..a67eda44 --- /dev/null +++ b/Contributions/Notebook Archive/readme.md @@ -0,0 +1 @@ +## [Notebook Archive][https://notebookarchive.org/] diff --git a/Contributions/Wolfram Data Repository/readme.md b/Contributions/Wolfram Data Repository/readme.md new file mode 100644 index 00000000..0e2e03cf --- /dev/null +++ b/Contributions/Wolfram Data Repository/readme.md @@ -0,0 +1 @@ +## [Wolfram Data Repository][https://reference.wolfram.com/language/guide/WolframDataRepository.html] diff --git a/Contributions/Wolfram Demonstrations Project/readme.md b/Contributions/Wolfram Demonstrations Project/readme.md new file mode 100644 index 00000000..066a71a9 --- /dev/null +++ b/Contributions/Wolfram Demonstrations Project/readme.md @@ -0,0 +1 @@ +## [Wolfram Demonstrations Project][http://demonstrations.wolfram.com/] diff --git a/Contributions/Wolfram Function Repository/readme.md b/Contributions/Wolfram Function Repository/readme.md new file mode 100644 index 00000000..3c179f7a --- /dev/null +++ b/Contributions/Wolfram Function Repository/readme.md @@ -0,0 +1 @@ +## [Wolfram Function Repository][https://resources.wolframcloud.com/FunctionRepository/] diff --git a/Contributions/Wolfram Neural Network Repository/readme.md b/Contributions/Wolfram Neural Network Repository/readme.md new file mode 100644 index 00000000..5a3fd74c --- /dev/null +++ b/Contributions/Wolfram Neural Network Repository/readme.md @@ -0,0 +1 @@ +## [Wolfram Neural Net Repository][http://resources.wolframcloud.com/NeuralNetRepository] diff --git a/Contributions/readme.md b/Contributions/readme.md new file mode 100644 index 00000000..5eeb9895 --- /dev/null +++ b/Contributions/readme.md @@ -0,0 +1,9 @@ +## "Contributions" folder +the place to store extra work products such as draft submissions to the data repo, function repo, neural net repo, and notebook archive. Follow the conventions described in the readme.md of that directory. There are instructions in the readme.md of the "Contributions" folder. + +### [Notebook Archive][https://notebookarchive.org/] +### [Wolfram Community][https://community.wolfram.com/] +### [Wolfram Data Repository][https://reference.wolfram.com/language/guide/WolframDataRepository.html] +### [Wolfram Function Repository][https://resources.wolframcloud.com/FunctionRepository/] +### [Wolfram Neural Net Repository][http://resources.wolframcloud.com/NeuralNetRepository] +### [Wolfram Demonstrations Project][http://demonstrations.wolfram.com/] diff --git a/Wolfram Community Post/readme.md b/Wolfram Community Post/readme.md new file mode 100644 index 00000000..09dc1da8 --- /dev/null +++ b/Wolfram Community Post/readme.md @@ -0,0 +1,52 @@ +This is a sample student repository for the Wolfram Summer School, you should clone or fork this repository to get started. + +## GETTING STARTED + +### Create a GitHub account +https://github.com/join + +### Create a repo to submit your work +fork this repo, clone local copy, and push your updates to GitHub.com (see below for more details) + +### Give your instructor write permissions +you need to give write permission to that repo to your tutor and to @WolframSummerSchoolProjects. Additionally please give write permissions to @kylekeane and @swedewhite for organizational purposes (you can revoke these at the end of school). + +## CONTENT + +### "Final Project" folder +the place to submit your entire final project, including draft work if you want. There are templates and instructions in the subdirectories described in the readme.md of the "Final Project" folder. + +### "Homework" folder +the place to submit your homework assignment (computational essay). There are templates and instructions in the subdirectories described in the readme.md of the "Homework" folder. + +### "Contributions" folder +the place to store extra work products such as draft submissions to the data repo, function repo, neural net repo, and notebook archive. Follow the conventions described in the readme.md of that directory. There are instructions in the readme.md of the "Contributions" folder. + +## MORE INFO ABOUT USING GITHUB + +### 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 + +### Edit your files locally +work on your computer and push to the cloud when you are ready to save your work + +### Write/edit readme files 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