Skip to content
Snippets Groups Projects
Commit 5f91176b authored by Neil Gershenfeld's avatar Neil Gershenfeld
Browse files

Merge branch 'master' into 'master'

Giving people proper instructions

See merge request academany/fabacademy/2019/docs/FabAcademy-Tutorials!1
parents 4ac19eff 938273b9
No related branches found
No related tags found
No related merge requests found
......@@ -6,14 +6,14 @@ A living collection of tutorials created by Fab Academy instructors/students aro
Additions are always welcome, but if you are creating a modified version of a tutorial, don't duplicate information. Just update the existing tutorials.
Tutorials can be created in any language, but use of English is strongly encouraged for maximum diffusion.
1. Create a [github](https://github.com/) account if you don't have already one.
2. [Fork](https://help.github.com/articles/fork-a-repo/) the [FabAcademy-Tutorials repository](https://github.com/Academany/FabAcademy-Tutorials)
1. Create a https://fablabs.io/ account if you don't have already one.
2. [Fork](https://docs.gitlab.com/ee/gitlab-basics/fork-project.html) the [FabAcademy-Tutorials repository](https://gitlab.fabcloud.org/academany/fabacademy/2019/docs/FabAcademy-Tutorials)
3. You will find a folder for each week/assignment. Create your tutorial inside the corresponding assignment folder.
5. Your tutorial name must clarify the OS and language used in the tutorial. Example: `shopbot_windows_english.md`
6. Write your tutorial using [Markdown](https://en.wikipedia.org/wiki/Markdown). If it is your first time writing in Markdown follow [this tutorial](http://www.markdowntutorial.com/). Your can use any text editor like [Atom](https://atom.io/), [Sublime](http://www.sublimetext.com/), [Brackets](http://brackets.io/), or [Notepad++](https://notepad-plus-plus.org/)
7. We have provided a [template](template.md) for creating new tutorials in case you need a guideline.
* If you need to host images or files, create a folder next to your tutorial using the same name as the tutorial (example `shopbot_windows_english`). Put your images and files inside it. Recommended images size is 800x600 pixels.
8. Keep it simple. Less is more.
9. Once you are done. [Create a pull request](https://help.github.com/articles/creating-a-pull-request/) to have your tutorial approved by the mighty instructors.
10. Once approved you can read your tutorial in the [tutorials gitbook](http://docs.academany.org/FabAcademy-Tutorials/_book/)
9. Once you are done. [Create a merge request](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) to have your tutorial approved by the mighty instructors.
10. Once approved you can read your tutorial in the [tutorials book](http://docs.academany.org/FabAcademy-Tutorials/_book/)
11. [Thanks](https://upload.wikimedia.org/wikipedia/commons/3/30/DcvfThank-you-1.jpg) for your contribution!
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment