Tutorial: Workspace and Repository Management (vcode)

Overall Repository

C:\Users\(user_name)\source\repos

1. EC workspace (lab, tutorial, include)

This is the local folder where you do your tutorial, lab.

Create the EC workspace:

• Create a folder named as "EC" in "C:\users(user_name)\source\repos".

• Create 3 folders named as "tutorial", "lab" and "include" in "EC" folder.

  • tutorial / lab : includes the project files.

  • include : includes header files. (If you’ve finished the Tutorial-PlatformIO in VSCode, this folder will already be created.)

Create a new project & Include library paths

• Create a new folder in "lab" or "tutorial".

  • named as "LAB_(title)" or "TU_(title)"

If you are using PlatformIO, you can skip the steps below.

• Create a new project and set for embedded board. Tutorial: Create a project with uVision

• Then, set "Include Paths" as "C:\users(user_name)\source\repos\EC\include".

include path

2. EC-student repository (provided source codes from EC github)

This is where you download or fetch the provided source codes used in EC lecture.

Clone the repository "EC-student"

github.com/ykkimhgu/EC-student

• Open with Github Desktop.

open with github desktop

• Check "Local path" and Click "Clone".

clone a repository

• Then, you can see the repository "EC-student" is copied in your local PC.

• You can copy & paste some files for tutorial or lab.

local repository

3. Your private github repository

This is for managing the version of your library and your source file. DO NOT include the project related files.

Create a new git repository

• Create a new repository in Github.

  • Repository name : EC-(your initials)-(3 ends of student number)

• You must choose Private.

• Add a README file.

create a repository

Clone github repository in local folder

• Open with Github Desktop from github repository

open with github desktop

• Check "Local path", and click "clone".

clone a repository

Create folders

• docs : documents for functions

• include : includes header files

• lab : includes report and source files

• tutorial : includes source files

local repository

Commit & Push

• Copy & paste only source files from your project directory.

copy src files

• Github Desktop shows changed things.

github desktop

• Commit : records the modified things.

commit

• Push to github

push

github

Collaborator

• Click [Settings] - [Collaborators] - [Add people]

• Search professor and TA id and add them as collaborator.

  • ykkimhgu

  • ckdals9150

add collaborators

add a collaborator