Skip to content
Snippets Groups Projects
Commit c209ffe0 authored by Sosuke Kanegae's avatar Sosuke Kanegae
Browse files

edited week01

parent 0b6425b1
No related branches found
No related tags found
No related merge requests found
......@@ -204,7 +204,7 @@
<li class="md-nav__item">
<a href="/." class="md-nav__link">
Index
Home
</a>
</li>
......
......@@ -213,7 +213,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Index
Home
</a>
</li>
......
......@@ -213,7 +213,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Index
Home
</a>
</li>
......
......@@ -211,7 +211,7 @@
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
Index
Home
</a>
</li>
......@@ -380,6 +380,13 @@
Setting up MkDocs
</a>
</li>
<li class="md-nav__item">
<a href="#build-commit-and-push" class="md-nav__link">
Build, Commit and Push
</a>
</li>
</ul>
......@@ -476,6 +483,13 @@
Setting up MkDocs
</a>
</li>
<li class="md-nav__item">
<a href="#build-commit-and-push" class="md-nav__link">
Build, Commit and Push
</a>
</li>
</ul>
......@@ -509,11 +523,11 @@
</ul>
<h2 id="what-ive-done-this-week">What I've done this week</h2>
<ol>
<li>Setting up PC enviroments<ol>
<li>Setting up workspace</li>
<li>Setting up PC enviroments<ul>
<li>Visual Studio Code (VScode)</li>
<li>Git</li>
<li>MkDocs</li>
</ol>
</ul>
</li>
<li>Create a <a href="../../">website</a></li>
<li>Sign up <a href="../../agreements/">Student Agreements</a></li>
......@@ -525,7 +539,7 @@
<ul>
<li>MacBook Air (M1, 2020)</li>
<li>macOS Monterey 12.3.1</li>
<li>Visual Studio Code 1.74.3</li>
<li>VSCode 1.74.3</li>
<li>zsh 5.8 (x86_64-apple-darwin21.0)</li>
<li>Homebrew 3.6.20</li>
<li>python 3.10.8 / pip 22.3.1</li>
......@@ -537,8 +551,8 @@
</code></pre>
<h3 id="choose-text-editor"><strong>Choose Text Editor</strong></h3>
<p>Text Editors are software where you write your codes in.</p>
<p>I chose Visual Studio Code (VScode) for my text editor.</p>
<p>VSCode has wide range of extensions that help you code, debug and visualise your work. Here are the extensions I installed for Fab Academy:</p>
<p>I chose VScode for my text editor.</p>
<p>VScode has wide range of extensions that help you code, debug and visualise your work. Here are the extensions I installed for Fab Academy:</p>
<ul>
<li>Git History</li>
<li>HTML CSS Support</li>
......@@ -565,7 +579,7 @@ ssh-keygen -t rsa -C "sosuke.kaneage@mat.eng.osaka-u.ac.jp"
<pre><code>cat ~/.ssh/id_rsa.pub
</code></pre>
<h3 id="clone-my-repository-from-gitlab-to-a-local-workspace"><strong>Clone my repository from GitLab to a local workspace</strong></h3>
<p>Now so that I got Git ready, I prepaired a new directory to store everything I do with Fab Academy. </p>
<p>Now so that I got Git ready, I prepaired a new directory to store everything I do with Fab Academy.</p>
<pre><code>cd ~/FabAcademy/
mkdir workspace
</code></pre>
......@@ -587,6 +601,12 @@ mkdocs new fabacademy-docs
<pre><code>mkdocs serve
</code></pre>
<p>Now, I have a MkDocs project with the default settings in ~/FabAcademy/workspace/fabacademy-docs. And, I can check how the website will look in my browser(<a href="http://127.0.0.1:8000/">http://127.0.0.1:8000/</a>).</p>
<h3 id="build-commit-and-push"><strong>Build, Commit and Push</strong></h3>
<p>After editing MkDocs project, I have to convert the markdowns to HTML files.</p>
<pre><code>cd ~/FabAcademy/workspace/fabacademy-docs
mkdocs build
</code></pre>
<p>The build commmand creates HTML files in ~/FabAcademy/workspace/fabacademy-docs/site/</p>
......
......@@ -213,7 +213,7 @@
<li class="md-nav__item">
<a href=".." class="md-nav__link">
Index
Home
</a>
</li>
......
......@@ -19,7 +19,7 @@
<title>Index - Sosuke Kanegae Fab Academy</title>
<title>Home - Sosuke Kanegae Fab Academy</title>
......@@ -100,7 +100,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Index
Home
</span>
</div>
......@@ -220,12 +220,12 @@
<label class="md-nav__link md-nav__link--active" for="__toc">
Index
Home
<span class="md-nav__icon md-icon"></span>
</label>
<a href="." class="md-nav__link md-nav__link--active">
Index
Home
</a>
......
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Sosuke Kaneage Fab Academy site!","text":"<p>My name is Sosuke and this is my Fab Academy documentation website. </p>"},{"location":"#final-project","title":"Final Project","text":""},{"location":"#weekly-assignments","title":"Weekly assignments","text":"<ul> <li>week 1. Principles and Practices / Project Management</li> <li>week 2. Computer Aided design</li> <li>week 3. Computer controlled cutting</li> <li>week 4. Embedded programming</li> <li>week 5. 3D Scanning and printing</li> <li>week 6. Electronics design</li> <li>week 7. Computer controlled machining</li> <li>week 8. Electronics production</li> <li>week 9. Molding and casting</li> <li>week 10. Output devices</li> <li>week 11. Mechanical design &amp; machine design</li> <li>week 12. Input devices</li> <li>week 13. Networking and communications</li> <li>week 14. Interface and application programming</li> <li>week 15. Wildcard week</li> <li>week 16. Applications and implications</li> <li>week 17. Invention, intellectual property and income</li> <li>week 18. Project development</li> </ul>"},{"location":"about/","title":"Hi! I am Sosuke Kanegae.","text":""},{"location":"about/#i-am-a-phd-student-in-osaka-university-japan","title":"I am a PhD student in Osaka University, Japan.","text":""},{"location":"about/#who-i-am","title":"Who I am","text":"<p>I am a human.</p>"},{"location":"about/#my-intensions","title":"My Intensions","text":"<p>I want to create a 3D lighting projector.</p>"},{"location":"agreements/","title":"Fab Academy Student Agreement","text":"<p>The Fab Academy is responsible for:</p> <ul> <li>Teaching principles and practices of digital fabrication</li> <li>Arranging lectures, recitations, meetings, and events for the class</li> <li>Evaluating and providing feedback on student work</li> <li>Offering clear standards for completing assignments</li> <li>Certifying and archiving student progress</li> <li>Supervising class preparation</li> <li>Reviewing prospective students, instructors, and labs</li> <li>Providing central staff and infrastructure for students, instructors, and labs</li> <li>Fund-raising for costs not covered by student tuition</li> <li>Managing and reporting on the program's finances, results, and impacts</li> <li>Publicizing the program</li> <li>Promoting a respectful environment free of harassment and discrimination</li> <li>Encourage a diverse, accessible, and equitable community</li> </ul> <p>I am a Fab Academy student, responsible for:</p> <ul> <li>Attending class lectures and participating in reviews</li> <li>Developing and documenting projects assigned to introduce and demonstrate skills</li> <li>Allowing the Fab Academy to share my work (with attribution) in the class for purposes compatible with its mission</li> <li>Honestly reporting on my work, and appropriately attributing the work of others (both human and machine)</li> <li>Working safely</li> <li>Leaving workspaces in the same (or better) condition than I found them</li> <li>Participating in the upkeep of my lab</li> <li>Ensuring that my tuition for local and central class costs is covered</li> <li>Following locally applicable health and safety guidance</li> <li>Promoting a respectful environment free of harassment and discrimination</li> </ul> <p>Signed by committing this file in my repository,</p> <p>Sosuke Kanegae</p>"},{"location":"final-project/","title":"Final Project","text":"<p>This page describes my final project idea.</p> <p></p>"},{"location":"assignments/week01/","title":"Week 01. Principles and Practices / Project Management","text":"<p>The first week of Fab Academy! I did a sketch of my project and added it to the Final Project page.</p>"},{"location":"assignments/week01/#assignments-for-this-week","title":"Assignments for this week","text":"<ul> <li>plan and sketch a potential final project</li> <li>work through a git tutorial</li> <li>build a personal site in the class archive describing you and your final project</li> </ul>"},{"location":"assignments/week01/#what-ive-done-this-week","title":"What I've done this week","text":"<ol> <li>Setting up PC enviroments<ol> <li>Setting up workspace</li> <li>Git</li> <li>MkDocs</li> </ol> </li> <li>Create a website</li> <li>Sign up Student Agreements</li> <li>Plan a final project</li> </ol>"},{"location":"assignments/week01/#1-setting-up-pc-enviroments","title":"1. Setting up PC enviroments","text":"<p>The First thing I did this week was Setting up my PC enviroment.</p> <p>Here are the version of tools I use.</p> <ul> <li>MacBook Air (M1, 2020)</li> <li>macOS Monterey 12.3.1</li> <li>Visual Studio Code 1.74.3</li> <li>zsh 5.8 (x86_64-apple-darwin21.0)</li> <li>Homebrew 3.6.20</li> <li>python 3.10.8 / pip 22.3.1</li> <li>git 2.39.1</li> <li>mkdocs 1.4.2</li> </ul> <p>I changed my mac screenshot setting from the default(PNG) to JPG with the following command.</p> <pre><code>defaults write com.apple.screencapture type jpg\n</code></pre>"},{"location":"assignments/week01/#choose-text-editor","title":"Choose Text Editor","text":"<p>Text Editors are software where you write your codes in.</p> <p>I chose Visual Studio Code (VScode) for my text editor.</p> <p>VSCode has wide range of extensions that help you code, debug and visualise your work. Here are the extensions I installed for Fab Academy:</p> <ul> <li>Git History</li> <li>HTML CSS Support</li> <li>Markdown All in One</li> </ul>"},{"location":"assignments/week01/#getting-started-with-git","title":"Getting started with Git","text":"<p>I followed this tutorial of Git.</p> <p>Step 1. Download Git.</p> <pre><code>brew install git\n</code></pre> <p>Step 2. Identify user.</p> <pre><code>git config --global user.name \"sosuke\"\ngit config --global user.email \"sosuke.kanegae@mat.eng.osaka-u.ac.jp\"\n</code></pre> <p>Step 3. Check if there is any SSH-Key existing. If not generate SSH-Key.</p> <pre><code>(check)\ncat ~/.ssh/id_rsa.pub\n\n(generate)\nssh-keygen -t rsa -C \"sosuke.kaneage@mat.eng.osaka-u.ac.jp\"\n</code></pre> <p>Step 4. Check the public key you just created.</p> <pre><code>cat ~/.ssh/id_rsa.pub\n</code></pre>"},{"location":"assignments/week01/#clone-my-repository-from-gitlab-to-a-local-workspace","title":"Clone my repository from GitLab to a local workspace","text":"<p>Now so that I got Git ready, I prepaired a new directory to store everything I do with Fab Academy. </p> <pre><code>cd ~/FabAcademy/\nmkdir workspace\n</code></pre> <p>In new workspace, I first cloned my repo on GitLab</p> <pre><code>git clone https://gitlab.fabcloud.org/academany/fabacademy/2023/labs/kitakagaya/students/sosuke-kanegae.git\n</code></pre> <p>Now, I have a newly cloned directory \"sosuke-kaneage\" in my workspace. And, I am ready to edit my website.</p>"},{"location":"assignments/week01/#setting-up-mkdocs","title":"Setting up MkDocs","text":"<p>Using MkDocs, you can easily create documentatoin websites. You will have to code in HTML, CSS and JavaScript to create a website. However, in MkDocs all you have to edit is Markdowns, which is easy to use.</p> <p>Step 1. Install MkDocs.</p> <pre><code>pip install mkdocs\n</code></pre> <p>Step 2. Create new Mkdocs project in workspace</p> <pre><code>cd ~/FabAcademy/workspace\nmkdocs new fabacademy-docs\n</code></pre> <p>Step 3. Launch test server</p> <pre><code>mkdocs serve\n</code></pre> <p>Now, I have a MkDocs project with the default settings in ~/FabAcademy/workspace/fabacademy-docs. And, I can check how the website will look in my browser(http://127.0.0.1:8000/).</p>"}]}
\ No newline at end of file
{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Sosuke Kaneage Fab Academy site!","text":"<p>My name is Sosuke and this is my Fab Academy documentation website. </p>"},{"location":"#final-project","title":"Final Project","text":""},{"location":"#weekly-assignments","title":"Weekly assignments","text":"<ul> <li>week 1. Principles and Practices / Project Management</li> <li>week 2. Computer Aided design</li> <li>week 3. Computer controlled cutting</li> <li>week 4. Embedded programming</li> <li>week 5. 3D Scanning and printing</li> <li>week 6. Electronics design</li> <li>week 7. Computer controlled machining</li> <li>week 8. Electronics production</li> <li>week 9. Molding and casting</li> <li>week 10. Output devices</li> <li>week 11. Mechanical design &amp; machine design</li> <li>week 12. Input devices</li> <li>week 13. Networking and communications</li> <li>week 14. Interface and application programming</li> <li>week 15. Wildcard week</li> <li>week 16. Applications and implications</li> <li>week 17. Invention, intellectual property and income</li> <li>week 18. Project development</li> </ul>"},{"location":"about/","title":"Hi! I am Sosuke Kanegae.","text":""},{"location":"about/#i-am-a-phd-student-in-osaka-university-japan","title":"I am a PhD student in Osaka University, Japan.","text":""},{"location":"about/#who-i-am","title":"Who I am","text":"<p>I am a human.</p>"},{"location":"about/#my-intensions","title":"My Intensions","text":"<p>I want to create a 3D lighting projector.</p>"},{"location":"agreements/","title":"Fab Academy Student Agreement","text":"<p>The Fab Academy is responsible for:</p> <ul> <li>Teaching principles and practices of digital fabrication</li> <li>Arranging lectures, recitations, meetings, and events for the class</li> <li>Evaluating and providing feedback on student work</li> <li>Offering clear standards for completing assignments</li> <li>Certifying and archiving student progress</li> <li>Supervising class preparation</li> <li>Reviewing prospective students, instructors, and labs</li> <li>Providing central staff and infrastructure for students, instructors, and labs</li> <li>Fund-raising for costs not covered by student tuition</li> <li>Managing and reporting on the program's finances, results, and impacts</li> <li>Publicizing the program</li> <li>Promoting a respectful environment free of harassment and discrimination</li> <li>Encourage a diverse, accessible, and equitable community</li> </ul> <p>I am a Fab Academy student, responsible for:</p> <ul> <li>Attending class lectures and participating in reviews</li> <li>Developing and documenting projects assigned to introduce and demonstrate skills</li> <li>Allowing the Fab Academy to share my work (with attribution) in the class for purposes compatible with its mission</li> <li>Honestly reporting on my work, and appropriately attributing the work of others (both human and machine)</li> <li>Working safely</li> <li>Leaving workspaces in the same (or better) condition than I found them</li> <li>Participating in the upkeep of my lab</li> <li>Ensuring that my tuition for local and central class costs is covered</li> <li>Following locally applicable health and safety guidance</li> <li>Promoting a respectful environment free of harassment and discrimination</li> </ul> <p>Signed by committing this file in my repository,</p> <p>Sosuke Kanegae</p>"},{"location":"final-project/","title":"Final Project","text":"<p>This page describes my final project idea.</p> <p></p>"},{"location":"assignments/week01/","title":"Week 01. Principles and Practices / Project Management","text":"<p>The first week of Fab Academy! I did a sketch of my project and added it to the Final Project page.</p>"},{"location":"assignments/week01/#assignments-for-this-week","title":"Assignments for this week","text":"<ul> <li>plan and sketch a potential final project</li> <li>work through a git tutorial</li> <li>build a personal site in the class archive describing you and your final project</li> </ul>"},{"location":"assignments/week01/#what-ive-done-this-week","title":"What I've done this week","text":"<ol> <li>Setting up PC enviroments<ul> <li>Visual Studio Code (VScode)</li> <li>Git</li> <li>MkDocs</li> </ul> </li> <li>Create a website</li> <li>Sign up Student Agreements</li> <li>Plan a final project</li> </ol>"},{"location":"assignments/week01/#1-setting-up-pc-enviroments","title":"1. Setting up PC enviroments","text":"<p>The First thing I did this week was Setting up my PC enviroment.</p> <p>Here are the version of tools I use.</p> <ul> <li>MacBook Air (M1, 2020)</li> <li>macOS Monterey 12.3.1</li> <li>VSCode 1.74.3</li> <li>zsh 5.8 (x86_64-apple-darwin21.0)</li> <li>Homebrew 3.6.20</li> <li>python 3.10.8 / pip 22.3.1</li> <li>git 2.39.1</li> <li>mkdocs 1.4.2</li> </ul> <p>I changed my mac screenshot setting from the default(PNG) to JPG with the following command.</p> <pre><code>defaults write com.apple.screencapture type jpg\n</code></pre>"},{"location":"assignments/week01/#choose-text-editor","title":"Choose Text Editor","text":"<p>Text Editors are software where you write your codes in.</p> <p>I chose VScode for my text editor.</p> <p>VScode has wide range of extensions that help you code, debug and visualise your work. Here are the extensions I installed for Fab Academy:</p> <ul> <li>Git History</li> <li>HTML CSS Support</li> <li>Markdown All in One</li> </ul>"},{"location":"assignments/week01/#getting-started-with-git","title":"Getting started with Git","text":"<p>I followed this tutorial of Git.</p> <p>Step 1. Download Git.</p> <pre><code>brew install git\n</code></pre> <p>Step 2. Identify user.</p> <pre><code>git config --global user.name \"sosuke\"\ngit config --global user.email \"sosuke.kanegae@mat.eng.osaka-u.ac.jp\"\n</code></pre> <p>Step 3. Check if there is any SSH-Key existing. If not generate SSH-Key.</p> <pre><code>(check)\ncat ~/.ssh/id_rsa.pub\n\n(generate)\nssh-keygen -t rsa -C \"sosuke.kaneage@mat.eng.osaka-u.ac.jp\"\n</code></pre> <p>Step 4. Check the public key you just created.</p> <pre><code>cat ~/.ssh/id_rsa.pub\n</code></pre>"},{"location":"assignments/week01/#clone-my-repository-from-gitlab-to-a-local-workspace","title":"Clone my repository from GitLab to a local workspace","text":"<p>Now so that I got Git ready, I prepaired a new directory to store everything I do with Fab Academy.</p> <pre><code>cd ~/FabAcademy/\nmkdir workspace\n</code></pre> <p>In new workspace, I first cloned my repo on GitLab</p> <pre><code>git clone https://gitlab.fabcloud.org/academany/fabacademy/2023/labs/kitakagaya/students/sosuke-kanegae.git\n</code></pre> <p>Now, I have a newly cloned directory \"sosuke-kaneage\" in my workspace. And, I am ready to edit my website.</p>"},{"location":"assignments/week01/#setting-up-mkdocs","title":"Setting up MkDocs","text":"<p>Using MkDocs, you can easily create documentatoin websites. You will have to code in HTML, CSS and JavaScript to create a website. However, in MkDocs all you have to edit is Markdowns, which is easy to use.</p> <p>Step 1. Install MkDocs.</p> <pre><code>pip install mkdocs\n</code></pre> <p>Step 2. Create new Mkdocs project in workspace</p> <pre><code>cd ~/FabAcademy/workspace\nmkdocs new fabacademy-docs\n</code></pre> <p>Step 3. Launch test server</p> <pre><code>mkdocs serve\n</code></pre> <p>Now, I have a MkDocs project with the default settings in ~/FabAcademy/workspace/fabacademy-docs. And, I can check how the website will look in my browser(http://127.0.0.1:8000/).</p>"},{"location":"assignments/week01/#build-commit-and-push","title":"Build, Commit and Push","text":"<p>After editing MkDocs project, I have to convert the markdowns to HTML files.</p> <pre><code>cd ~/FabAcademy/workspace/fabacademy-docs\nmkdocs build\n</code></pre> <p>The build commmand creates HTML files in ~/FabAcademy/workspace/fabacademy-docs/site/</p>"}]}
\ No newline at end of file
No preview for this file type
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment