Skip to content

Add Building section explaining submodule and build commands#230

Closed
dennisdoomen wants to merge 1 commit into
Fallout-build:mainfrom
dennisdoomen:docs/building-section-submodule
Closed

Add Building section explaining submodule and build commands#230
dennisdoomen wants to merge 1 commit into
Fallout-build:mainfrom
dennisdoomen:docs/building-section-submodule

Conversation

@dennisdoomen

@dennisdoomen dennisdoomen commented May 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a Building section to README.md that explains:

  • The repo uses a git submodule (vendor/vs-solutionpersistence) that must be initialised before building — without it Fallout.VisualStudio.SolutionPersistence fails with a missing .resx error.
  • How to initialise the submodule on an existing clone (git submodule update --init) and how to pull it in one step when cloning fresh (git clone --recurse-submodules).
  • The build.ps1 / build.sh entry points and the most common targets (Compile, Test, --help).

Also adds Building to the Table of Contents.

@dennisdoomen dennisdoomen changed the title docs: add Building section explaining submodule and build commands Add Building section explaining submodule and build commands May 27, 2026
@ChrisonSimtian ChrisonSimtian added the documentation Improvements or additions to documentation label May 27, 2026
@ChrisonSimtian
ChrisonSimtian self-requested a review May 27, 2026 21:23
@ChrisonSimtian

Copy link
Copy Markdown
Collaborator

thanks for adding that in :-)
Just a headsup: I do tend to work quite a bit with submodules where it makes sense.

This particular one is probably something that should at some point become part of this project because Microsoft wont be maintaining this library in a way its helpful to us. Might as well move forward, write our own SLNX parser and dunno maybe drag along the SLN one until this format dies? (one day .... together with windows forms and VB :D )

ChrisonSimtian added a commit that referenced this pull request May 27, 2026
…/tests (#232)

* chore(repo): add CODEOWNERS pointing to @ChrisonSimtian

Prep for tightening main branch protection now that external
contributors are opening PRs (dennisdoomen, #222 / #230).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(repo): scope CODEOWNERS to /src and /tests only

Docs, build orchestrator, CI workflows, and root config remain
unowned. The follow-up branch-protection update will pair this
with required_approving_review_count=0 + require_code_owner_reviews=true,
so docs PRs need only CI green while src/tests PRs require explicit
owner approval.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@ChrisonSimtian ChrisonSimtian left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ChrisonSimtian
ChrisonSimtian force-pushed the docs/building-section-submodule branch from 2956691 to 639eaa2 Compare May 28, 2026 03:01
@ChrisonSimtian

Copy link
Copy Markdown
Collaborator

I just replaced the submodule with an inhouse solution, so that part can probably drop off

The vendor/vs-solutionpersistence submodule must be initialised before
building. Add a Building section to README.md that covers:
- the git submodule init requirement and the two ways to fetch it
- the build.ps1 / build.sh entry points and common targets

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dennisdoomen
dennisdoomen force-pushed the docs/building-section-submodule branch from 639eaa2 to 2265dc6 Compare May 28, 2026 09:47
@dennisdoomen

Copy link
Copy Markdown
Collaborator Author

Ah, then we can close this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants