search

CommunityToolkit / MVVM-Samples

Sample repo for MVVM package
Other
1.11k stars 222 forks source link

Sample Projects missing Files? #117

Open amrit7 opened 1 year ago

amrit7 commented 1 year ago

Hi,

I downloaded the ZIP file for MVVM-Samples from GitHub and having the following issues, related to empty folders / missing files:

  1. This folder is empty in the ZIP file: MVVM-Samples-master\msdocs-communitytoolkit
  2. The Project MvvmSampleUWP does not build as it cannot find any files under: \msdocs-communitytoolkit\docs\mvvm

For example - I can see the Project is trying to find, but is unable to do so:

<Content Include="..\..\msdocs-communitytoolkit\docs\mvvm\generators\Overview.md">
  <Link>Assets\docs\generators\Overview.md</Link>
  <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>

Please can you review and check the samples are working.

Thanks

michael-hawker commented 1 year ago

@amrit7 there's a submodule, so you need to be sure to clone the submodules as well when working in the repo. @Sergio0694 probably should add a line in the readme about how to do the checkout?

amrit7 commented 1 year ago

thank you - that helped :) Yes, I agree, something in the Readme with steps for Checkout would be useful.

Looking at the Git Code, how can you tell if there's a submodule, is it the arrow on the folder or folder name with the @ symbol? I'm not quite sure the purpose/benefits of the submodule.

michael-hawker commented 1 year ago

@amrit7 yup, the submodule is denoted with the arrowed folder, as seen here:

image

Submodules allows one git repository to include the source of another. This is useful for a variety of reasons, but here it's because rather than copying files from the documentation of the other repository to use within the app, we can include a submodule to directly reference them instead. It makes it easier to keep the app in-sync with the documentation.