TODO: Make readmes for entire project

• Need to establish a sort of protocol like flow.
• The idea is to be able to parse this info later to do amazing l=things like compile parts lists, sources and even full models if all STL files are there.

Open Source Ordnance

Welcome to Open Source Ordnance, a repository dedicated to providing open-source 3D printed weapons, weapon parts, and modifications for self-defense. This project aims to ensure accessibility and self-defense capabilities for individuals under various circumstances.

Table of Contents

1. Weapons
2. Weapon Parts and Mods
   • Functional Mods
     • Add Subdirectories here...
   • Gear Mods
   • Vital Parts

Project Structure

THIS IS JUST PALCEHOLDER MOSTLY FOR NOW

Weapons

The weapons folder contains a collection of Markdown documents, each dedicated to a unique weapon. These documents provide detailed information, instructions, and credits for each weapon model.

Weapon Parts and Mods

Functional Mods

The functional_mods directory includes 3D printable modifications that enhance the functionality of weapons. Inside, you'll find a models folder containing the 3D models and corresponding Markdown documents with information on linked items, required items, usage instructions, and credits.

Gear Mods

The gear_mods directory encompasses 3D printed gear modifications for weapons. Like the functional mods, it has a models folder with associated Markdown documents detailing linked items, required items, usage guidelines, and credits.

Vital Parts

In the vital_parts directory, you'll find essential 3D printed components crucial for the proper functioning of weapons. The models folder contains 3D models, and the Markdown documents offer information on linked items, required items, usage instructions, and credits.

How to Contribute

We welcome contributions from the community to enhance the repository. To contribute, please follow these steps:

1. Fork the repository.
2. Create a branch for your changes.
3. Make your modifications.
4. Submit a pull request.

Credits

We appreciate the efforts of all contributors who make Open Source Ordnance possible. Please check individual Markdown documents for specific model credits.

Disclaimer

This project is meant for educational purposes and lawful self-defense. Ensure compliance with local laws and regulations before using or distributing any 3D printed weapons or components.

Stay safe, and exercise responsible use of technology for self-defense.