From b086db2f267e68e8f10f4408cec27186bbe1ab35 Mon Sep 17 00:00:00 2001 From: Dmytro Vakulenko <42547595+dimitrovakulenko@users.noreply.github.com> Date: Thu, 3 Oct 2024 15:51:58 +0200 Subject: [PATCH] Update README.md --- README.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 98a3700..8e185a6 100644 --- a/README.md +++ b/README.md @@ -97,9 +97,33 @@ Once the plugin is loaded in AutoCAD, you can use it as follows: Once you've made changes, click "Recompile Script" to verify if the errors are resolved. -### Software Architecture +### Software Architecture: Concepts -*(This section will be filled in by the developer)* +- Initial script generation: ask LLM to generate script by description, try compile script, if there are errors ask LLM to fix the errors maximum N times +- Automatic fixing / fine-tuning: provide additional content to LLM when it tries to fix compilation errors, an additional content can be all existing properties and methods of a specific class to avoid hallucinations/unexisting methods creation + +![Architecture: state machine](.assets/architecture_stateMachine.png) + +### Software Architecture: Technical + +**The solution** + +Consists of next projects: +- ScriptureCore: contains all core services required by the plugin: script generation service (communication to LLM), script commpilation service (Roslyn API). +- ScriptureCore.Tests: contains tests for the core services +- ScriptureUI: a simple WPF control to host the UI; a proper viewmodel tbd; +- ScriptureHarnessApp: enabled testing fo the UI control without running the complete plugin from Autocad +- Scripture: Autocad .Net plugin, depends on ObjectARX.Net API + +**Installer** + +Installer implemented using Wix 3.1x. +Scripture.Installer project results in plugin msi installer. +Scripture.Bundle.Installer project results in exe file that install plugin and .Net runtime. + +**CI & Release Builds** + +Implemented as github actions ### License