Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No Documentation of API #70

Open
RyanDaley opened this issue Aug 30, 2022 · 1 comment
Open

No Documentation of API #70

RyanDaley opened this issue Aug 30, 2022 · 1 comment

Comments

@RyanDaley
Copy link

Is there no documentation for the API?
I guess I can just learn how to use this GeometryGymIFC namespace through the examples, but I'm surprised by the lack of technical documentation.

@jmirtsch
Copy link
Collaborator

Hi Ryan,

Thanks for posting, I hope you find the development helpful and interesting.
Can you clarify the technical documentation you're seeking?
buildingSMART document the classes, attributes and relationships, you can find this at https://technical.buildingsmart.org/standards/ifc/ifc-schema-specifications/?sfw=pass1661382182

The Geometry Gym toolkit is a c# implementation of this standard, for reading/writing IFC files.
We have limited resources (ie time) to devote to documenting the toolkit, but of course we welcome
external contributions from any others willing to help make the process easier for new developers.

If you have suggestions, we will certainly consider what we might do ourselves. Examples and
sample code is certainly what we have focused on given that buildingSMART maintains the specification.

Look forward to discussing further,

Jon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants