OD_Submodules/readme.md
2026-04-19 10:32:20 -05:00

95 lines
3.6 KiB
Markdown

<div align="right" >
<p align="right" >
<img src="https://raw.githubusercontent.com/OpeningDesign/OD_Marketing/master/Logos/od_icon_logo_2.jpg" width="120px"/>
</p>
</div>
## OpeningDesign
An (uberly) transparent & open source architectural studio.
---
This repo is a shared assets library for OpeningDesign's ongoing projects.
It stores reusable resources like:
- **CSS stylesheets** for CAD/drawing presentation (legends, schedules, equipment, shading)
- **SVG assets** — symbols, markers, and patterns for drawings
- **IFC templates** — BIM property sets and quantity take-offs
- **Reference files** — Architectural, Civil, and Structural drawing references
#### Setup
To use, locate the repo 'next to' the project folder--that way the relative links will work.
```
OD_Submodules (Level 1)
├─── assets
├─── OD_Textures
├─── psets
├─── references
├─── schedules
Project Folder (Level 1)
├─── Open
└─── _Encrypted
```
If you use the following paths in your preferences, when you create new drawings in Bonsai, they will point to this asset folder.
![](_imgs/drawing_preferences.png)
Location of common libraries:
```
..\..\..\..\OD_Submodules\psets
..\..\..\..\OD_Submodules\assets\default.css
..\..\..\..\OD_Submodules\assets\schedule.css
..\..\..\..\OD_Submodules\assets\markers.svg
..\..\..\..\OD_Submodules\assets\symbols.svg
..\..\..\..\OD_Submodules\assets\patterns.svg
..\..\..\..\OD_Submodules\assets\shading_styles.json
```
---
#### Contributing
This library grows more useful the more it reflects real-world project needs. If you're using [Bonsai](https://bonsaibim.org/) or working with IFC-based workflows and have assets worth sharing — stylesheets, symbols, psets, reference details — contributions are very welcome.
To contribute:
1. If you don't have an account on https://hub.openingdesign.com/ ping me at ryan@openingdesign.com
1. Fork the repo
2. Create a branch (`git checkout -b my-new-asset`)
3. Add or modify assets
4. Open a pull request with a brief description of what you added and why
Not sure if something is a good fit? Bring it up [here](https://hub.openingdesign.com/OpeningDesign/OD_Submodules/issues) before opening a PR — happy to discuss.
---
#### In-the-Open
All of [OpeningDesign's](http://openingdesign.com/) projects are conducted out-in-the-open. That is, during the development of any one project, all the content is hosted publicly on [Github](https://github.com/OpeningDesign), [Gitlab](https://gitlab.com/OpeningDesign) or [Gitea](https://hub.openingdesign.com/OpeningDesign) and is [open source](https://en.wikipedia.org/wiki/Open_source). All team communication is conducted through public [Matrix](https://app.element.io/#/room/#openingdesign:matrix.org) chat rooms.
Our [about page](http://openingdesign.com/about/) provides a more nuanced description of this open approach.
---
#### License
Per usual, unless otherwise noted, all content associated with [OpeningDesign](http://openingdesign.com) projects is licensed under an open source, 'copyleft' license:
[Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/)--freely available to any party, for any use, assuming the terms such as [Attribution](https://wiki.creativecommons.org/wiki/best_practices_for_attribution) and [ShareAlike](https://en.wikipedia.org/wiki/Share-alike) are honored. Attribution to be given to the entire team associated with the project.
![Attribution-ShareAlike 4.0 International](http://i.creativecommons.org/l/by-sa/3.0/88x31.png)
---