Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 39 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,61 @@
# IFC 5 development repository
# IFC 5 Development Repository

Welcome to the **IFC 5 alpha Examples**! These examples are the result of years of work by many volunteers. The IFC implementer forum, the IFC 5 taskforce, and the wider community of interested implementers, have been working on these examples inntensively. This repository contains initial examples for the IFC 5 developments.
**Welcome to the IFC 5 Alpha Examples!**
These examples are the result of years of collaborative work by many volunteers. The IFC Implementer Forum, the IFC 5 Taskforce, and the wider community of interested implementers have been working intensively on these examples. This repository contains initial examples for the development of IFC 5.

## Disclaimer: Early Stage Examples
---

Please note that these examples are **preliminary** and represent a direction of working for IFC 5. There are several **important caveats** to keep in mind:
## ⚠️ Disclaimer: Early Stage Examples

1. **Incomplete Features**: Many features of IFC 5 have not been fully explored or implemented in these examples.
2. **Schema Changes**: IFC 5 is still evolving, and future updates to the development will require revisions to these examples.
3. **Limited Validation**: These examples have undergone significant validation and testing. However, they are still incomplete.
4. **Known Issues**: There are known and unknown issues and incomplete sections within the examples.
5. **Development in Progress**: Further work is needed to improve the quality, accuracy, and completeness of these examples.
Please note that these examples are preliminary and represent a working direction for IFC 5. Several important caveats should be kept in mind:

## Viewer
- **Incomplete Features**: Many features of IFC 5 have not yet been fully explored or implemented in these examples.
- **Schema Changes**: IFC 5 is still evolving, and future updates to the schema will require revisions to these examples.
- **Limited Validation**: While these examples have undergone significant validation and testing, they remain incomplete.
- **Known Issues**: There are both known and unknown issues, as well as incomplete sections within the examples.
- **Development in Progress**: Further work is needed to improve the quality, accuracy, and completeness of these examples.

A viewer to visualize and explore the files is available under /docs/viewer. It is also live on https://ifc5.technical.buildingsmart.org/viewer/
The viewer source code is MIT licensed. The intent is to help users understand the examples; and to help software developers to understand how to implement the composition of the objects.
---

## Schema
## 🧭 Viewer

The schema sourece is defined using typespec and can be found under /schema.
The JSON schema of IFC, and extensions will be published on ifcx.dev
A viewer to visualize and explore the files is available under `/docs/viewer`.
It is also live at https://ifc5.technical.buildingsmart.org/viewerrpose is to help users understand the examples and assist software developers in implementing object composition.

## Future Development
---

Further **documentation will follow soon**.
We are actively working on enhancing these examples, addressing known issues. Contributions, feedback, and collaboration are welcome! If you would like to contribute or discuss the development of these examples, feel free to open an issue.

## 📘 Schema

## Usage
The schema source is defined using **Typespec** and can be found under `/schema`.
The JSON schema for IFC and its extensions will be published on https://ifcx.dev.

You are welcome to clone or download this repository, but please bear in mind the current limitations and treat these examples as a **work in progress**.
Do not create derivatives of these examples, but please actively contribute with PRs and opening issues.
---

## Feedback and Contributions
## 🚀 Future Development

We highly encourage feedback from the community and contributions from those familiar with IFC 5 or similar standards. Please adhere to the buildingSMART behavior policy when discussing on GitHub and the forums.
Further documentation will be provided soon. We are actively working on enhancing these examples and addressing known issues. Contributions, feedback, and collaboration are welcome!
If you would like to contribute or discuss the development of these examples, feel free to open an issue.

---

**Please Note**: The examples provided here are for **educational and testing purposes** only. They are not suitable for production use without further refinement.
## 📦 Usage

You are welcome to clone or download this repository, but please keep in mind the current limitations and treat these examples as a work in progress.
**Do not create derivatives** of these examples. Instead, we encourage you to actively contribute by submitting pull requests and opening issues.

---

Thank you for your interest, and we look forward to building out these examples together!
## 💬 Feedback and Contributions

We strongly encourage feedback from the community and contributions from those familiar with IFC 5 or similar standards.
Please adhere to the **buildingSMART behavior policy** when participating in discussions on GitHub and the forums.

---

## 📎 Please Note

The examples provided here are intended for **educational and testing purposes only**.
They are **not suitable for production use** without further refinement.

---