From c92bee92d3e56b94f13b9a9e4b4d899f5307b17d Mon Sep 17 00:00:00 2001 From: Matthias Prinke Date: Thu, 18 Jul 2024 14:25:55 +0200 Subject: [PATCH] Added Documentation.md, added tag, updated README.md --- .../projects/ExampleProjects/doc/Documentation.md | 13 +++++++++++++ AppExamples/projects/ExampleProjects/doc/README.md | 8 +++++--- AppExamples/projects/ExampleProjects/metainfo.json | 4 +++- 3 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 AppExamples/projects/ExampleProjects/doc/Documentation.md diff --git a/AppExamples/projects/ExampleProjects/doc/Documentation.md b/AppExamples/projects/ExampleProjects/doc/Documentation.md new file mode 100644 index 0000000..6326af0 --- /dev/null +++ b/AppExamples/projects/ExampleProjects/doc/Documentation.md @@ -0,0 +1,13 @@ +## ExampleProjects + +Most of the App examples rely on a certain ZEISS INSPECT project file to be loaded. Some examples load the projects automatically when it is possible (E.g. in the `if __name__ == '__main__'` block) while other example require the project to be loaded manually. This is easily done using the `setup_project.py` script. + +The project files are stored in this App to avoid duplication across multiple Apps. + +The following project files are included: + +| Project name | Description | +| --------------------------- | ------------------------------------------------------------------------- | +| zeiss_part_test_project | Simple optically measured part with a CAD, mesh and some basic inspection | +| volume_test_part | A small test volume for CT related inspections | +| zeiss_part_test_measurement | Optical measurement series and preliminary mesh of ZEISS part | \ No newline at end of file diff --git a/AppExamples/projects/ExampleProjects/doc/README.md b/AppExamples/projects/ExampleProjects/doc/README.md index 00ab503..881079b 100644 --- a/AppExamples/projects/ExampleProjects/doc/README.md +++ b/AppExamples/projects/ExampleProjects/doc/README.md @@ -1,7 +1,9 @@ ## ExampleProjects -This App is part of the [ZEISS INSPECT Python API Examples](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/python_examples/index.html). +This App is part of the [ZEISS INSPECT Python API App Examples](https://github.com/ZEISS/zeiss-inspect-app-examples/tree/main/AppExamples). -It provides ZEISS INSPECT projects for trying the Python API examples. +See [App documentation](Documentation.md) for details. -You can [download this App](https://software-store.zeiss.com/products/apps/ExampleProjects) from the [ZEISS Quality Software Store](https://software-store.zeiss.com). \ No newline at end of file +You can [download this App](https://software-store.zeiss.com/products/apps/ExampleProjects) from the [ZEISS Quality Software Store](https://software-store.zeiss.com). + +The ZEISS INSPECT App develomment documentation can be found on [ZEISS IQS GitHub](https://zeissiqs.github.io/zeiss-inspect-addon-api/2025/index.html). diff --git a/AppExamples/projects/ExampleProjects/metainfo.json b/AppExamples/projects/ExampleProjects/metainfo.json index 5a801ed..745fadc 100644 --- a/AppExamples/projects/ExampleProjects/metainfo.json +++ b/AppExamples/projects/ExampleProjects/metainfo.json @@ -9,7 +9,9 @@ }, "software-revision": "0000", "software-version": "ZEISS INSPECT 2025", - "tags": [], + "tags": [ + "project" + ], "title": "ExampleProjects", "uuid": "eaca1f5c-bad1-4a37-b68b-7928fe46bf8c", "version": "1.0.0"