New instruction by Badura-m · Pull Request #2 · MicrocontrollerApplications/Utilities

Badura-m · 2025-04-10T11:47:57Z

Please check the instruction!

Basti-iTAS-PLMS · 2025-04-11T05:59:50Z

+Git is nowadays probably the most common Version Control System for Software Development. Version Control is mainly used to create a development history 
+during development. This reduces the potential of data loss and enables one to easily reset changes. Furthermore, in professional software development teams 


Suggested change

Git is nowadays probably the most common Version Control System for Software Development. Version Control is mainly used to create a development history

during development. This reduces the potential of data loss and enables one to easily reset changes. Furthermore, in professional software development teams

Git is nowadays probably the most common Version Control System for Software Development. Version Control is used to create a change history during development.

This reduces the potential of data loss and enables one to easily reset changes. Furthermore, in professional software development teams

Basti-iTAS-PLMS · 2025-04-11T06:01:06Z

+during development. This reduces the potential of data loss and enables one to easily reset changes. Furthermore, in professional software development teams 
+Version Control can be used to review the work of colleagues to improve code quality and reduce the potential for bugs.
+
+Within this lecture we will not actively use Git, but GitHub to provdie you with the relevant code for your laboratory sessions.


Suggested change

Within this lecture we will not actively use Git, but GitHub to provdie you with the relevant code for your laboratory sessions.

Within this lecture we will not actively use Git, but provide you with the corresponding code for your lab sessions via GitHub.

Basti-iTAS-PLMS · 2025-04-11T06:01:50Z

+Version Control can be used to review the work of colleagues to improve code quality and reduce the potential for bugs.
+
+Within this lecture we will not actively use Git, but GitHub to provdie you with the relevant code for your laboratory sessions.
+Therefore, mainly one feature of Git is necessary - cloning a repository. Those who want to know more about Git, should take a look at the [References](#references)


Suggested change

Therefore, mainly one feature of Git is necessary - cloning a repository. Those who want to know more about Git, should take a look at the [References](#references)

Therefore, mainly one feature of Git is necessary - cloning a repository, which will be explained within this manual.

Those who want to know more about Git, should take a look at the [References](#references)

Basti-iTAS-PLMS · 2025-04-11T06:02:29Z

+Therefore, mainly one feature of Git is necessary - cloning a repository. Those who want to know more about Git, should take a look at the [References](#references)
+
+## Git Clone
+If not stated otherwise within the repositories README, cloning a git repository is always the same and requires the below 3 steps.


Suggested change

If not stated otherwise within the repositories README, cloning a git repository is always the same and requires the below 3 steps.

If not stated otherwise within the repositories README, cloning a git repository is always the same and requires the below two steps.

Third step is optional after the first time done, isn't it?

fixed, yes it is

Basti-iTAS-PLMS · 2025-04-11T06:03:44Z

+![How to get repository link](git_images/getRepoLink.png)
+### 2. Open MPLAB X IDE and clone the current repository
+---
+Before you start, make sure that all your old projects are closed. 


Why that? I MPLAB running into issues if there are open projects?
If so, I guess we have to explain how to close a proejct.

If the project is open you can not clone a new git repository but it is possible to work in the opend one

Basti-iTAS-PLMS · 2025-04-11T06:03:58Z

+### 2. Open MPLAB X IDE and clone the current repository
+---
+Before you start, make sure that all your old projects are closed. 
+To clone the repository please follow the instructions:


Suggested change

To clone the repository please follow the instructions:

To clone the repository please follow the below instructions:

Basti-iTAS-PLMS · 2025-04-11T06:04:43Z

+4. choose in the toolbar TEAM
+5. choos GIT --> clone
+6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next
+7. select main as your remote Branche, select Next


Suggested change

7. select main as your remote Branche, select Next

7. select main as your remote Branch, click Next

Basti-iTAS-PLMS · 2025-04-11T06:04:56Z

+3. close all open projects
+4. choose in the toolbar TEAM
+5. choos GIT --> clone
+6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next


Suggested change

6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next

6. enter the repository link and choose the Destination Folder U://Microcontroller, click Next

Basti-iTAS-PLMS · 2025-04-11T06:05:21Z

+3. close all open projects
+4. choose in the toolbar TEAM
+5. choos GIT --> clone
+6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next


Suggested change

6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next

6. enter the repository link and choose the Destination Folder U:/Microcontroller, select Next

Are two slashes (//) required? I'm not sure right now.

Basti-iTAS-PLMS · 2025-04-11T06:07:02Z

+
+![](git_images/mplab_cloneCLIB_1.gif)
+
+If you want your repository to be stored in a different folder simply change the location from *U:\Microcontroller\* to you prefered location. But keep in mind that it's harder to support you in case you use a different setup.


Suggested change

If you want your repository to be stored in a different folder simply change the location from *U:\Microcontroller\* to you prefered location. But keep in mind that it's harder to support you in case you use a different setup.

If you want your repositories to be stored in a different folder simply change the location from *U:/Microcontroller/* to your preferred location. But keep in mind that it's harder to support you in case you use a different setup and that **you need to make sure that _C_LIB is always positioned correctly**!

Basti-iTAS-PLMS · 2025-04-11T06:11:40Z

+---
+Before you start, make sure that all your old projects are closed. 
+To clone the repository please follow the instructions:
+![](git_images/mplab_cloneGit_3.gif)


Sadly the GIFs resolution is not that good, within the README.
Either tell them to click on it to have a better resolution, or focus the GIF on the Git window and add a screenshot to show how to open it via Team -> Git -> ....

I will try a different tool

I tried to re film it, can you check the quality ? It lookes quite good on my laptop

Still can't read the links. But as you added a written manual too, we should give it a try ;) :)

Basti-iTAS-PLMS · 2025-04-11T06:12:19Z

+> [!WARNING]
+> In case you already cloned the library into your working folder - **do not clone it a second time!** 
+
+![](git_images/mplab_cloneCLIB_1.gif)


Same as for the other GIF, resolution within the README is very low...
Would re-record it, showing only the Git window.

I will add written discrption and try a different tool

Basti-iTAS-PLMS · 2025-04-11T07:25:11Z

 This repository contains all relevant documentation for tools, libraries etc. used within the lectures. Below links lead you to the related documentation. Just click on them to open it. :)

 1. [Git](git.md)
+


Please don't use empty lines in enumerations.
It's confusing to read (in source mode) and I don't know if it can lead to rendering issues.

Basti-iTAS-PLMS · 2025-04-11T07:26:24Z

-To clone the repository please follow the instructions:
-![](git_images/mplab_cloneGit_3.gif)
+Before you start, make sure that all your old projects are closed. To do so, you need to right-click on the microcontroller symbol of your current project shown in the left-hand column and then select *close*.
+To clone the repository please the below instructions:


Suggested change

To clone the repository please the below instructions:

To clone the repository please follow the below instructions:

Basti-iTAS-PLMS · 2025-04-11T07:28:07Z

+For those who do like to have written instructions: 
+1. Open the [GitHub repository _C_LIB](https://github.com/MicrocontrollerApplications/_C_Lib)
+2. Copy the repository link (see ### 1.)
+3. follow step 2. to 8. of the in ### 2. described instructions


Suggested change

3. follow step 2. to 8. of the in ### 2. described instructions

3. follow step 2. to 8. of the instructions described in ### 2.

Basti-iTAS-PLMS

Just a hint ;)

Basti-iTAS-PLMS · 2025-04-11T07:37:39Z

+![](git_images/clone_repo_V2.gif)
+
+For those who do like to have written instructions:
+1. copy the repository link (see ### 1.)


regarding the "### 1.":
Chapters can be linked in Markdown, but without an IDE that auto-generates you the links it's quite a mess.
When we're done with everything else, I can add those links for you and show you next week how I did that using VS Code (which is by the way great for writing Markdown ;) )

that sounds good

Basti-iTAS-PLMS

Please wait until I added the references, before you merge this PR :)

Basti-iTAS-PLMS

Please revise changed before merging.

Badura-m added 3 commits April 10, 2025 13:27

Add files via upload

f535126

Add files via upload

feb1f09

Create gitViaMPLABX.md

d6c761c

Basti-iTAS-PLMS self-requested a review April 10, 2025 11:52

Basti-iTAS-PLMS requested changes Apr 11, 2025

View reviewed changes

Badura-m added 5 commits April 11, 2025 08:33

Update gitViaMPLABX.md

e0deed5

Update gitViaMPLABX.md

9132064

Update README.md

5a9504b

Add files via upload

26f25df

Update gitViaMPLABX.md

567d007

Badura-m requested a review from Basti-iTAS-PLMS April 11, 2025 07:13

Basti-iTAS-PLMS requested changes Apr 11, 2025

View reviewed changes

Basti-iTAS-PLMS reviewed Apr 11, 2025

View reviewed changes

Badura-m added 2 commits April 11, 2025 09:46

Update README.md

7c7f9d9

Update gitViaMPLABX.md

f9c784a

Basti-iTAS-PLMS previously approved these changes Apr 11, 2025

View reviewed changes

add cross-references to chapters for written instructions

45f50c2

Basti-iTAS-PLMS assigned Badura-m Apr 11, 2025

Basti-iTAS-PLMS dismissed their stale review via 45f50c2 April 11, 2025 14:55

Basti-iTAS-PLMS approved these changes Apr 11, 2025

View reviewed changes

		Git is nowadays probably the most common Version Control System for Software Development. Version Control is mainly used to create a development history
		during development. This reduces the potential of data loss and enables one to easily reset changes. Furthermore, in professional software development teams

	Within this lecture we will not actively use Git, but GitHub to provdie you with the relevant code for your laboratory sessions.
	Within this lecture we will not actively use Git, but provide you with the corresponding code for your lab sessions via GitHub.

	Therefore, mainly one feature of Git is necessary - cloning a repository. Those who want to know more about Git, should take a look at the [References](#references)
	Therefore, mainly one feature of Git is necessary - cloning a repository, which will be explained within this manual.
	Those who want to know more about Git, should take a look at the [References](#references)

	If not stated otherwise within the repositories README, cloning a git repository is always the same and requires the below 3 steps.
	If not stated otherwise within the repositories README, cloning a git repository is always the same and requires the below two steps.

	To clone the repository please follow the instructions:
	To clone the repository please follow the below instructions:

	7. select main as your remote Branche, select Next
	7. select main as your remote Branch, click Next

	6. enter the repository link and choose the Destination Folder U://Microcontroller, select Next
	6. enter the repository link and choose the Destination Folder U://Microcontroller, click Next


		![](git_images/mplab_cloneCLIB_1.gif)

		If you want your repository to be stored in a different folder simply change the location from U:\Microcontroller\ to you prefered location. But keep in mind that it's harder to support you in case you use a different setup.

	If you want your repository to be stored in a different folder simply change the location from U:\Microcontroller\ to you prefered location. But keep in mind that it's harder to support you in case you use a different setup.
	If you want your repositories to be stored in a different folder simply change the location from U:/Microcontroller/ to your preferred location. But keep in mind that it's harder to support you in case you use a different setup and that you need to make sure that _C_LIB is always positioned correctly!

		This repository contains all relevant documentation for tools, libraries etc. used within the lectures. Below links lead you to the related documentation. Just click on them to open it. :)

		1. [Git](git.md)

	To clone the repository please the below instructions:
	To clone the repository please follow the below instructions:

	3. follow step 2. to 8. of the in ### 2. described instructions
	3. follow step 2. to 8. of the instructions described in ### 2.

Conversation

Badura-m commented Apr 10, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Basti-iTAS-PLMS left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Basti-iTAS-PLMS left a comment

Choose a reason for hiding this comment

Uh oh!

Basti-iTAS-PLMS left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees