FINAL PROJECT / WEEK 1 / COMPUTER AIDED DESIGN / COMPUTER-CONTROLLED-CUTTING / ELECTRONICS PRODUCTION / 3D SCANNING & PRINTING / ELECTRONICS DESIGN / COMPUTER-CONTROLLED MACHINING / EMBEDDED PROGRAMMING / MECHANICAL DESIGN / MACHINE DESIGN / INPUT DEVICES / 3D MOLDING AND CASTING / OUTPUT DEVICES / COMPOSITES / EMBEDDED NETWORKING & COMMUNICATIONS / INTERFACE AND APPLICATION PROGRAMMING / APPLICATIONS AND IMPLICATIONS / INVENTION, INTELLECTUAL PROPERTY, AND BUSINESS MODELS / PROJECT DEVELOPMENT

Week 1 - Principles and Practices & Project-management

Januar 27 - Februar 3

Lesson Link - Principles and Practices, Projectmanagement, Video, Git Tutorial Fiore, Ferdis Tutorial

*Weeks Assignment*

* Build a personal site 
* descibe you and your final project
* describe how you build the website. 

* Upload website to the class archive 

* Do a git tutorial.

Git Tutorial

I only got into git a couple of weeks earlier and can recommend this tutorial. Some other good tutorials I found here and visual guide here.

I also downloaded a couple of desktop git programs like github desktop and tower but decided to use the command line instead.

A friend recommended me Xtra Finder. This way you can open a folder in Terminal by right clicking and selecting Open in Terminal.

Create a local repository

To create a local git folder you need to create a folder. Open the folder by right clicking in Terminal. Type the following.

git init
git add <filename>
git commit -m "initial commit"

Create a remote repository

To make a remote respository create a respository on github and copy the link.

git remote add origin http://git ...

git push -u origin master

git clone https://... Make local copy of remote repo

git pull origin master Now remote and local are in sync. git status Show the working tree status git add . Add all the files git commit -m "inital commit" Record changes to the repository git push Update remote repository

To update your remote respository you go into the folder you want to work in. Right click and open on Terminal.

git status (the files that you have change are)

git add . (the files turn green)

git commit -m "blaba"

git pull

git push

If you and up in vim. Type ":" and "q" to get out of it.

At fabacademy we are not using github but gitlab. So there already exists a folder for you on the fablab git hub server. You can check out gitlab by signing into it with you fablab.io account. On http://git.fabacademy.org/ click on fablabs.

git clone git@git.fabacademy.org:fabacademy2016/fablabbcn2016.git

git config --global user.name "John Doe"

http://archive.fabacademy.org/archives/2016/fablabbcn2016/docu/ferdi/htm/week01_git.html#clone-archive

I am traveling at the moment and I realized that its better to set up your repositories with https instead of ssh because it seems that some hotels or at my lufthansa flight ssh was blocked.

Check what your remote repository is with git remote -v

Change the remote rep to the https address of github git remote set-url origin https://github.com/ARKopp/fabacademy2016.git

I still have not figured how it would work in gitlab

git remote set-url origin http://git.fabacademy.org/fabacademy2016/fablabbcn2016.git

If you want to switch back to ssh you can so with ...

git remote set-url origin git@git.fabacademy.org:fabacademy2016/fablabbcn2016.git

The workflow for the fabacademy is the following. Go into the folder of the html files of your documentation. Open it in Terminal.

git pull

git add . (its a dot)

git commit -m "message"

git push

Here is also a cheat sheet that was created from one of the fabacademy student.

My Website

Markdown to static html generator

Because I quite like the Markdown language and the documentation needs to uploaded to git lab anyway I decided to write all my documentation in Markdown and use a script to generate the html files. As a Markdown Editor I am using Macdown a open source Markdown editor for Mac.

I found this Markdown to static html generator with build in themes.

That is how you install it (before you need to have node js installed)

sudo npm install -g markdown-styles

An that is how you generate the html files.

generate-md --layout github --input ./ --output ../fablabbcn2016/students/375/

You have couple of themes to choose from. I chose the github theme.

Preview of Website

To see how my website looks like in html I am starting a python server in the fabacademy folder were I am putting my html files.

python -m SimpleHTTPServer 8000

Then I can look at the website under this address http://localhost:8000/

Workflow

Write Documentation in Markdown in Macdown
Take pictures and screenshots while working
Use Airdrop to transfer pictures from phone to computer
Put pictures into folders of weeks
Make pictures smaller then 100KB
Add notes to pictures
Link pictures and files in Marfolder with keyboard short cut
Run script to generate html
Preview website with http://localhost:8000/
Go to my fablabbcn2016/students/375 folder
Open it in Terminal
Do git steps

Update 15. April:

Still the part where I have to transfer photos from my phone to the computer and to make pictures smaller is time consuming. Also I would like to have a Markdown editor for iphone so I can also document while not on my computer. Perfect would be voice input.

Final Project

My idea of a final project is to build a robotic post-it sticking machine.

Projectmanagement

Feedback ?

Twitter me or email me at andreasrkopp at gmail dot com.

Or chat with me on gitter.