- Overview: A short, clear summary of the project.
- Features: Highlights what the project does.
- Installation: How to install dependencies and set up the environment.
- Usage: Commands to run simulations, models, or tests.
- Demo Video: A short YouTube or GitHub-hosted video showcasing the results.
- References: Links to datasets, research papers, or other useful resources.
β Create a "Robotics Portfolio" Repository
- Example:
github.com/chuchuxu/robotics-portfolio - Inside, maintain folders for each major project.
β Use GitHub Projects (Kanban Board) to Track Progress
- Create a GitHub Project Board for your robotics tasks.
- Example columns: π TODO | π In Progress | β Completed.
β Pin Your Best Projects on Your GitHub Profile
- Go to Profile β Customize Profile β Pin Repositories.
β Use Issues & Discussions for Open-Source Collaboration
- Example: If your project is open-source, create an Issue Template so others can contribute.
- Use GitHub Pages + Jekyll to create a simple portfolio website.
- Example:
yourusername.github.ioshowcasing your best projects. - Template: Minimal Portfolio Jekyll Template.
- Share your projects as LinkedIn posts with videos & code snippets.
- Write detailed technical blogs on Medium, Dev.to, or Hashnode.
Example:
"How I Built a Deep Reinforcement Learning-Based Robotic Grasping System"
Hereβs an inspiration for structuring your portfolio:
π Example Robotics Engineer GitHub: Tobias Fischer
1οΈβ£ Set up your first robotics GitHub repository using the template above.
2οΈβ£ Create at least one README.md file with proper documentation.
3οΈβ£ Upload a demo video of a robotic simulation (even if itβs simple).
4οΈβ£ Write a blog post or LinkedIn article about your project.
5οΈβ£ Start contributing to open-source robotics projects (MoveIt, ROS, OpenCV).