summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1628890..1424ae5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
# ComputingME
Development repository for MECH 305 - Computing for Mechanical Engineers
+## Using this repository
+To get started with this repository, install git bash and run the following commands:
+
+```bash
+git clone https://github.com/c-kolset/ComputingME.git
+```
+
+Start Jupyter Notebook/Lab and navigate to the `ComputingME/tutorials/module_#/` directory, where `#` is the module number. Here you'll find the latest version of the jupyter notebook tutorials.
+
## Administive
Find meeting notes, course overview and Gantt charts in this directory. Below is a link to the meeting notes and images related to project management.
@@ -34,7 +43,7 @@ See the tutorials under the /tutorials/ directory.
- [Fundamentals of Computing](tutorials/module_1/fundamentals_of_programming.md)
- [Open source software](tutorials/module_1/open_source_software.md)
- [Computational Expense](tutorials/module_1/computational_expense.md)
-
+
#### Algorithm Developments for ME
- [Numerical Methods](tutorials/module_2/non_linear_eqn_solver.md)
- [Version Control](tutorials/module_2/version_control.md)