https://github.com/jonilsson/machine-shop-tutorials
Comprehensive machine shop tutorials and reference guide for machinists, fabricators, and makers
https://github.com/jonilsson/machine-shop-tutorials
documentation machining manufacturing mkdocs tutorials
Last synced: about 2 months ago
JSON representation
Comprehensive machine shop tutorials and reference guide for machinists, fabricators, and makers
- Host: GitHub
- URL: https://github.com/jonilsson/machine-shop-tutorials
- Owner: JoNilsson
- License: other
- Created: 2025-06-20T12:59:26.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-08-12T04:11:21.000Z (about 2 months ago)
- Last Synced: 2025-08-12T05:34:55.397Z (about 2 months ago)
- Topics: documentation, machining, manufacturing, mkdocs, tutorials
- Language: Makefile
- Homepage: https://jonilsson.github.io/machine-shop-tutorials/
- Size: 3.49 MB
- Stars: 8
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Machine Shop Tutorials Wiki
[![Deploy MkDocs][deploy-badge]][deploy-url]
[![Markdown Lint][lint-badge]][lint-url]
A comprehensive wiki-book for machinists, fabricators, and makers.
## 📚 Visit the Wiki
**[View the Machine Shop Tutorials Wiki →](https://jonilsson.github.io/machine-shop-tutorials/)**
## 🔧 About This Repository
This repository contains the source for the Machine Shop Tutorials Wiki,
a comprehensive guide covering:
- **Drill Press Mastery** - From basics to advanced techniques
- **Band Saw Operations** - Horizontal and vertical saw expertise
- **Precision Layout** - Bolt circles and coordinate calculations
- **Fundamental Skills** - Essential machining foundations
- **Measurement & QC** - Precision measuring and quality control
- **Shop Efficiency** - Time-saving techniques and custom tooling
## 🚀 Quick Start (For Contributors)
### Using Nix (Recommended)
```bash
nix develop
make serve
```
### Manual Setup
```bash
pip install -r requirements.txt
mkdocs serve
```
Visit to view the documentation locally.
## 📁 Repository Structure
```text
.
├── docs/ # MkDocs source files (the wiki content)
├── site/ # Built static site (git-ignored)
├── mkdocs.yml # MkDocs configuration
├── flake.nix # Nix development environment
├── Makefile # Build automation
└── [legacy dirs]/ # Original tutorials (now contain redirects)
```
## 🔄 Legacy Content
The original tutorial directories now contain redirect notices pointing
to the new wiki. This preserves existing links while guiding users to
the improved content.
## 📄 License
- **Content**: Creative Commons BY-SA 4.0
- **Code**: MIT License
See [LICENSE.md](LICENSE.md) for details.
## 👤 Author
**Johanness A. Nilsson**
[johanness.nilsson@terraformindustries.com](mailto:johanness.nilsson@terraformindustries.com)
---
*Building the future, one chip at a time.*
[deploy-badge]: https://github.com/JoNilsson/machine-shop-tutorials/actions/workflows/deploy.yml/badge.svg
[deploy-url]: https://github.com/JoNilsson/machine-shop-tutorials/actions/workflows/deploy.yml
[lint-badge]: https://github.com/JoNilsson/machine-shop-tutorials/actions/workflows/ci.yml/badge.svg
[lint-url]: https://github.com/JoNilsson/machine-shop-tutorials/actions/workflows/ci.yml