1. Principles & Practices and Project management

Learning outcomes - Communicate an initial project proposal - Identify and utilise version control protocol(s) - Explore and use website development tool(s)

Nueval 2025 Handbook

Principles & Practices

This week I worked on defining my final project idea and started to getting used to the documentation process. I oriningally was going to use HTML for my website, but have decided to move to MKdocs.

1.1 Final Project Proposal

I want to make a recreation of the Tron identity disc. In the movie the identity disc is like a hard drive where all memory in the grid is recorded on the disc. The final purpose of this project is just to develop my making and prop making skills.

Possible Features

Images

Link to Source

Video - Reference to the Prop

Project management

This week I started to getting used to the documentation process. Mainly this focuses on using Git. This is a tool I am not used to. Mainly I use google drive for storage of documents. However, I have been thinking about getting a storage and management system that can do versioning. This would be great for work on SVGs. As I have caught myself saving over things that I didn’t want to.

Git

For git I use the following tutorials to get my get bash working on my computer. I am using VS code to edit the MkDocs template. In VS Code I am using the Markdown Preview Enhanced extension for markdown.

The first step to getting git working locally is installing git bash for windows git bash. Git bash uses linux for the commands. Bellow I have unix commands that will help me navigate unix.

This is a good tutorial to start with git (Getting Git). Once getting git then you need to clone the site to your local computer. You have to make a key (password) to clone the repo to you computer for local work. This tutorial will help you make a key so you can clone your site to your computer (SSH Tutorial). Finally this tutorial will give instruction on how to add and commit files to the repo (First Commit Tutorial).

This image is of my cloning the rvk class site to start doing the group assignment.

Note That max push size is 10 MB!

General Steps for Using git

Website

I am using the MKdocs template. I have not done much to customize. Now I am using a new theme for my site.

This the the theme I am using. Cinder Theme

Following Svavar’s documentation was very handy. https://fabacademy.org/2023/labs/isafjordur/students/svavar-konradsson/assignments/week01.html#mkdocs-test-drive

Linux Code Help

I am using git bash for to commit to the repo. I followed the tutorials above to set up git bash on my personal computer. But below are some important linux commands you must know when using git

ls 
"list all items in the current directory"

cd 
"allows you to move for example cd anna-reneau/ will move you into the anna-reneau folder"

cd ..
"allows you to move back one space in the working directory"

pwd 
"print work directory - shows what folder you are currently working in"

Mkdocs Code Help

Here are some handy Mkdocs code needed to improve the work flow. 

pip install mkdocs-bootstrap386
"used to install different themes in mkdocs"


python -m mkdocs serve  
"commands python to make a test website using mkdocs"

Git Code Help

I am using git locally on my computer. Here are the commands need to ensure that all my work is commited to the repo. 

git status

git pull

git add .

git commit -m "comment"

git push

Keyboard Shortcuts

Fusion

Rotate View: Shift+Middle Mouse

Dimension: D

Measure: M

Construction: X

VsCode

Comment Lines Highlighted: Ctrl++

Uncomment Lines Highlighted: Ctrl+Shift+A

Spelling Extension: Ctrl+.

Open Preview Markdown: Ctrl+Shift+V

Dita's Gown by Francis Bitonti Studio on Sketchfab