Skip to content

Changes

Page history
Update S1: Tools I authored by Rodrigo's avatar Rodrigo
Hide whitespace changes
Inline Side-by-side
S1:-Tools-I.md
View page @ 693654af
......@@ -3,11 +3,11 @@
# Session 1: Tools-I
* **Time**: 2h
* **Date**: Wednesday, Jan-26th-2022
* **Date**: Wednesday, Jan-XX-2023
* **Goals**:
* Brief introduction to Github
* Brief introduction to Github/Gitlab
* Create your first repository
* Learn how to access to github from the Pycharm IDE
* Learn how to access to gitlab from the Pycharm IDE
* Testing the "Hello world" program in Pycharm
# Contents
......@@ -60,101 +60,96 @@ In this **subject** we will focus on the use of **Github**
### Our Github's account
* Create your account on [Github](https://github.com/). Do not forget to send your **real name** and your **username** in the post in Aula Virtual
* Once you have your account, Github will enable a link to your profile. This is my link (username: Obijuan):
* **Link**: https://github.com/obijuan
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-01.png)
You can find a repository tap in the top. It will show you all your current repos. In your profile page Github places the most popular repos
* Create your account on [Gitlab](https://gitlab.etsit.urjc.es/). Do not forget to send your **real name** and your **username** in the post in Aula Virtual
* Once you have your account, you can create and edit your profile Mine is [rperez](https://gitlab.etsit.urjc.es/rperez).
### Playing with repositories
Just to get familiar with Github, Let's see some of my repositories. Click on the [3D-parts](https://github.com/Obijuan/3D-parts) repo. This is the one I use for sharing all my **3D printable designs**. Anyone can download them, and print them on a **3D printer**
Just to get familiar with Gitlab, Let's see some of my repositories. Click on the [this repo](https://github.com/Obijuan/3D-parts) with 3D-parts. This is the one a colleage of mine uses for sharing all his **3D printable designs**. Anyone can download them, and print them.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-02.gif)
The designs are stored in their own **folders**. We can organize every repository **as we want**, using all the folder we need. In the bottom part you will see images and texts. They are the contents of the **README.md** file, that we can add optionally in every folder or repo
The designs are stored in **folders**. We can organize every repository **as we want**, using all the folders we may need. At the bottom of the page you will see images and texts, which are the contents of the **README.md** file, that we can add optionally in every folder or repo.
Let's continue our journey through the repos!. Let's enter into this folder: [2017-10-09-urjc-logo](https://github.com/Obijuan/3D-parts/tree/master/2017-10-09-urjc-logo)
Let's continue our journey through the repos!. Let's enter into [~~this folder~~](https://github.com/Obijuan/3D-parts/tree/master/2017-10-09-urjc-logo).
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-03.png)
There are **3 files** and **3 folders**. Most of the files can be seen directly just by clicking on them. For example, let's click on the [Logo_URJC.png](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/Logo_URJC.png) file
There are **3 files** and **3 folders**. Most of the files can be seen directly just by clicking on them. For example, let's click on the [Logo_URJC.png](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/Logo_URJC.png) file.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-04.png)
As it is a **png fil**e, Github shows it as an image. If we want to download it, just press the **Download** button in to top right
As it is a png file, Gitlab shows it as an image. If we want to download it, just press the **Download** button in to top right.
Any file from the repository can be downloaded. There is **no need for checking in**. No account is needed for browsing the report or for downloading any files from them
Any file from the repository can be downloaded. There is **no need for checking in**. No account is needed for browsing the report or for downloading files.
Let's see now this other file: [logo-urjc.svg](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/logo-urjc.svg). It is a drawing, in the [SVG](https://es.wikipedia.org/wiki/Gr%C3%A1ficos_vectoriales_escalables) vectorial format
Let's see now this other file: [logo-urjc.svg](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/logo-urjc.svg). It is a drawing, in the [SVG](https://es.wikipedia.org/wiki/Gr%C3%A1ficos_vectoriales_escalables) vectorial format.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-05.png)
As this is a **text file** (the SVG files are written in plain text), instead of the Download button there is a **RAW Button**. If we want to download it, just click with the **right mouse button** and select the _save link as_ option
As this is a **text file** (the SVG files are written in plain text), instead of the Download button there is a **RAW Button**. If we want to download it, just click with the **right mouse button** and select the _save link as_ option.
If we enter the **STL** folder and click on the file [urjc-coin.stl](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/stl/urjc-coin.stl), as it is a 3D design, Github will render it and allow us to **rotate** it and **change the point of view**
If we enter the **STL** folder and click on the file [urjc-coin.stl](https://github.com/Obijuan/3D-parts/blob/master/2017-10-09-urjc-logo/stl/urjc-coin.stl), as it is a 3D design, Github will render it and allow us to **rotate** it and **change the point of view**.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-06.png)
In this **animation** you can see our journey though this repository
In this **animation** you can see our journey though this repository.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-07.gif)
#### Wikis
Optionally, a **wiki page** can be added to any repo for storing the documentation, and making the information more accesible to the users. For example, in the previous 3D-part repo, I have added a **index** with the most import 3D parts
Optionally, a **wiki page** can be added to any repo for storing the documentation, and making the information more accessible to the users. For example, in the previous 3D-part repo, I have added a **index** with the most import 3D parts.
If you want to **access the wiki**, just click on the **wiki tab**
If you want to **access the wiki**, just click on the **wiki tab**.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-08.png)
The wiki's link is also available: https://github.com/Obijuan/3D-parts/wiki. It allows us to access it as if a standar. It looks like this:
The wiki's link is also available: https://github.com/Obijuan/3D-parts/wiki. It allows us to access it as if a standard. It looks like this:
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-09.png)
Now we can browse normally. The documentation that you are reading now, from the Programming in Network Environment subject, is located **its own wiki page** at Github :slight_smile:
Now we can browse normally. The documentation that you are reading now, from the Programming in Network Environment subject, is located in its **its own wiki page** :slight_smile:.
From the [3D parts wiki](https://github.com/Obijuan/3D-parts/wiki), enter to the this design: [URJC Keyring/coin](https://github.com/Obijuan/3D-parts/wiki/Llavero-moneda-URJC). It is located on the same folder we saw before, but now you are looking at the wiki, that is easier for the users
From the [3D parts wiki](https://github.com/Obijuan/3D-parts/wiki), enter to the [this design](https://github.com/Obijuan/3D-parts/wiki/Llavero-moneda-URJC). It is located on the same folder we saw before, but now you are looking at the wiki, that is easier for the users.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-10.png)
In this **animation** you can see our **journey** though the wiki
In this **animation** you can see our **journey** though the wiki.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-11.gif)
### Downloading all the files in a repo
You can download either individual files from the repo or all of them. Let's try the second option with this repo [RISC-V-FPGA](https://github.com/Obijuan/RISC-V-FPGA) (We do not use the previous repo because is too big and it will take us more time)
You can download either individual files from the repo or all of them. Let's try the second option with this repo [RISC-V-FPGA](https://github.com/Obijuan/RISC-V-FPGA) (We do not use the previous repo because is too big and it will take us more time).
In the **main page** of the repo, click on the **Clone or Download** green button
In the **main page** of the repo, click on the **Clone or Download** green button.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-15.png)
Select the **DOWNLOAD ZIP** option in the bottom of the new windows
Select the **DOWNLOAD ZIP** option in the bottom of the new windows.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-16.png)
The browser will show us another window with the **file to download**. Click on the **OK** button
The browser will show us another window with the **file to download**. Click on the **OK** button.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-17.png)
The complete process is shown in this animation
The complete process is shown in this animation.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-18.gif)
In our Download folder there wil be the file **RISC-V-FPGA.zip**, which contains all of the files and folders of that repo. But, **Be carefull!**. It only contains the latest version of the files, not the repo itself. All the information regarding changes, revisions and versions is not there
In our Download folder we will find the file we just downloaded But, **be careful!**, it only contains the latest version of the files, not the repo itself. All the information regarding changes, revisions and versions is not there.
We can **decompress** this file as usual to have access to all the files and folders
We can **decompress** this file as usual to have access to all the files and folders.
![](https://github.com/myTeachingURJC/2019-2020-CSAAI/raw/master/L01/github-19.gif)
### Creating our working repo
In this subject, all your work will be stored in a **public Github repo**. In this section we will create it from a **template repository**, which has beeen already configured
In this subject, all your work will be stored in a **public Gitlab repo**. In this section we will create it from a **template repository**, which has been already configured,
This is the repository. Click on the link to enter: [2019-2020-PNE-Practices](https://github.com/rodperex/PNE-lab)
This is the repository. [2019-2020-PNE-Practices](https://github.com/rodperex/PNE-lab)
![](https://github.com/davidrol6/2019-2020-PNE/raw/master/s1-tool-1/github-01.png)
......@@ -518,9 +513,9 @@ The only way of **mastering** something is practicing, practicing and practicing
The session is finished. Make sure, during this week, that everything in this list is checked!
* [ ] You have a Github account
* [ ] You have sent me your real name and Github user name
* [ ] You have the **2019-2020-PNE-Practices** working repo created in your account
* [ ] You have a Gitlab account
* [ ] You have sent me your real name and Gitlab user name
* [ ] You have the **pne-lab** working repo created in your account
* [ ] You know how to write and run programs in Pycharm
* [ ] You have uploaded the **Hello folder** with the **hello.py** program to the repo
* [ ] Exercise 1 done!
......@@ -529,8 +524,7 @@ The session is finished. Make sure, during this week, that everything in this li
# Credits
* [Juan González-Gómez](https://github.com/Obijuan) (Obijuan)
* [Alvaro del Castillo](https://github.com/acs). He designed and created the original content of this subject. Thanks a lot :-)
* Rodrigo Pérez Rodríguez
# License
......