This section should hold a quick intro on what this repo's about. For example:
This repo holds Speckle's:
- Default Code of Conduct,
- Default Contribution Guidelines,
- README template (you're reading it now),
- Default Issue Template,
- Default Pull Request Template,
- OSS License (Apache 2.0)
Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository.
Comprehensive developer and user documentation can be found in our:
Is rather straightforward. It includes several default sections and one section that requires special attention.
Default sections:
- Badges: has several default social badges. Feel free to add more.
- Developing & Debugging - needs filling in!
- Community - can be left as is.
License section: If this is a pure OSS repo, like Core, remove everything after the first phrase. Otherwise, we need to plan ahead before releasing and make sure we're covered.
What will you need?
- ArchiCad 27
- CMake – To generate IDE projects (3.16 minimum version is needed)
- Python – For some build tools (version 2.7+ or 3.8+).
- Visual Studio 2019 or 2022 (v142 toolset)
How to build the AddOn on Windows and Visual Studio 2022
- Make sure that your Visual Studio 2022 is installed properly and that you have the v142 toolset installed
- After modifying the installation, a restart may be necessary
- Open the project root and run
generate_project.bat - This will create the build folder and you will find the
archicad-speckle.slnin it - Open the solution file in Visual Studio 2022 and build the project
More Help
- Open the Add-On Manager in Archicad (Options menu)
- Click the "Add..." button under "Edit list of available Add-ons"
- Browse
./build/Int/Debug/Speckle.apx
- Right-click SpeckleAddOn in the Visual Studio solution explorer
- Click 'Set as Startup Project'
- Click run (Local Windows Debugger)
- By default it will start ArchiCAD 27, make sure that it's installed on your machine
Please make sure you read the contribution guidelines and code of conduct for an overview of the practices we try to follow.
The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!
For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.
Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.