Conversation
Rewrite README to lead with what SharpFM does (extract FileMaker objects as editable XML and round-trip them back) and why it's useful (version control, cross-RDP/Citrix, real editors, inspection). Drop the step-by-step menu/plugin walkthroughs in favor of a tighter How It Works section. Remove obsolete docs: - docs/plans/ — POCO migration is complete. - docs/step-definitions.md — the POCO migration tracker; all Priority 1 steps have typed implementations and the Priority 3 long tail is explicitly on-demand. - docs/plugins/ — described four plugin types (Panel, Event, Persistence, Transform) but only Panel and Transform exist; replaced with a minimal docs/plugins.md pointer to the contracts and sample project. Update docs/advanced-filemaker-scripting-syntax.md to note that Show Custom Dialog's Inputs: block is already implemented, and drop the single-entry change log.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Rewrite the README to lead with what SharpFM does — decode FileMaker's closed clipboard format into plain XML plus structured editors, let you edit/save/share/diff, and re-encode on the way back — and why that middle step is useful (version control, Remote Desktop/Citrix boundaries, real editors, inspection). Step-by-step menu walkthroughs and the plugin section collapsed into a tighter How It Works plus a plain feature list.
Trim
docs/:docs/plans/removed — the POCO migration it tracked is complete.docs/step-definitions.mdremoved — working checklist for the same migration; all Priority 1 steps have typed POCOs and the Priority 3 long tail is explicitly on-demand.docs/plugins/removed — described four plugin types but only Panel and Transform exist in code. Replaced with a minimaldocs/plugins.mdthat points at the contract projects and sample.docs/advanced-filemaker-scripting-syntax.md— noted thatInputs:blocks (Show Custom Dialog) are already implemented alongsideButtons:, and dropped the single-entry change log.No code changes; test suite still passes (1,177 tests, 0 failures).