1. State of the art, project management and documentation¶
For the first week of Fabricademy, we have to familiarize with the Gitlab platform and the Markdown language to fit our documentation website that we are going to use throughout the formation. We have to make two pages: the landing page with our presentation and motivation and the page for the firt week: State of the art, project management and documentation.
Documentation software¶
To keep track of and to be replicate, all experiments are will be documented in Gitlab platform. Images selected must be resize and optimize thanks to inkscape and gimp software and tinyPNG website before to be edited.
- This documentation was built using GitLab
- Mattermost chat
- Documentation source files are written in Markdown
- MkDocs
- Assessment platform: Nueval
Image¶
Before being uploaded to Gitlab, an image needs to go through several steps. - Crop it if necessary - Modify its size - Compress it (to no more than 100kb )
- Stock photography: Unsplash
- Stock photography: Pexels
- Free & Open Source Image Editor: GIMP
- Image collage: Photocollage
- Image compression: TinyPNG
CTRL + I: The selection is placed at the border of the cropped image.
Image > Crop according to selection
Image > Scale and size of the image > choose 300 pixel height
File > Export as > choose jpg or png (if transparent elements)
Once the image is the right size, use the TinyPNG site to compress it.
Video¶
- Free and open source software for video recording and live streaming: OBS Studio
- Video editing: Clipchamp
- GIFs & Animated Stickers online: Giphy
 |
 |
Digital fabrication website¶
References & Inspiration¶
- Community dedicated to learning hardware, from beginner to pro: Hackster
- Community for people who like to make things: Instructables
- Rather than buying something, make it. Browse thousands of projects created by the Arduino community: projecthub.arduino
- Design community for discovering, making, and sharing 3D printable things: Thingiverse