Skip to content

Commit

Permalink
Update project scope
Browse files Browse the repository at this point in the history
  • Loading branch information
gdr-at-ms committed Aug 22, 2023
1 parent 039a2b2 commit e61481c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ When you submit a pull request, a CLA bot will automatically determine whether y
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
provided by the bot. You will only need to do this once across all repos using our CLA.

## Scope
The IFC SDK is an implementation of the IFC Specification. It is purposefully
limited to providing I/O operations for reading and writing IFC files, and to
simple utilities for formatting or viewing IFC files. We welcome and are looking
for contributions that fix gaps between the IFC SDK and the IFC Specification, or
for changes required to match C++ standards starting from C++20 and upwards.

We are not yet accepting contributions that expand the project scope beyond adherence to the IFC Specication, as explained above.

We are making the IFC SDK available to the C++ community in the hope of helping to
advance C++ Modules implementation in other C++ compilers, and C++ Modules adoption in the C++ community at large.

## Formatting
There is a .clang-format file in the repo that should work with many editors automatically. Use "// clang format off" and "// clang format on" to prevent automatic formatting when necessary to preserve specific formatting.

Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# IFC SDK

The IFC SDK provides code to allow to read, write, and modify IFC files. It contains C++
structures that can be mapped directly onto the on-disk format.
See the IFC specification at [IFC Specification](https://github.com/microsoft/ifc-spec).
The IFC SDK provides datatypes and code supporting read and write of IFC files.
It contains C++
datatypes that can be memory-mapped directly onto the on-disk format.
See the [IFC Specification](https://github.com/microsoft/ifc-spec) for more details.

If you want to participate in the development of the IFC SDK, welcome! You can report issues, comment on pull requests, and learn about what we're working on. You can also submit pull requests to fix bugs or add features: see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
If you want to participate in the development of the IFC SDK, welcome! You can report issues, comment on pull requests, and learn about what we're working on. You can also submit pull requests to fix bugs or add features reflecting the [Specification](https://github.com/microsoft/ifc-spec): see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

Finally, you can take our code and use it in other apps and libraries (according to the terms of our license, like everything else)
Finally, you can take our code and use it in other programs or libraries (according to the terms of our license, like everything else)

# Building and Running
This project uses CMake for defining projects, and the code has been tested to work on Windows and Linux. It can be built and run under WSL (Windows Subsystem for Linux) as well.
Expand Down

0 comments on commit e61481c

Please sign in to comment.