search

nielsboecker / HoloRepository-HoloLens

A system for transforming medical imaging studies into holograms, storing them in the cloud and providing them to other systems.
GNU Affero General Public License v3.0
4 stars 0 forks source link

MRTK Examples should be removed from the project's git history #8

Closed nielsboecker closed 5 years ago

nielsboecker commented 5 years ago

Description

This repository is quite large in size. Actually it is more than my free GitHub account allows (in terms of bandwith): image

In theory, I would be fine with getting the $5/month subscription for August and September. But if we want to keep the repository online after the project, we should find a more sustainable solution. Also, it turns out that most of the size is caused by third-party components.

Analysis

When you clone the project, the folder size is 302 MB. It can be broken down like so (only showing hotspots):

Cloned without opening in Unity (which will download some further files): 302 MB
    .git folder: 141 MB
    Assets 159 MB
        MRTK Foundations folders: 16 MB
        MRTK Examples folder: 138 MB

Most of the filesize is occurring through the MixedRealityToolkit.Examples asset, The Foundation folders (MixedRealityToolkit, MixedRealityToolkit.Providers, MixedRealityToolkit.SDK, MixedRealityToolkit.Services) only make for about 16 MB.

Proposed solution

  1. I already tried to delete the MixedRealityToolkit.Examples folder. I think the only thing that breaks are that the buttons in the Connector Demo scene will disappear. Please copy the used assets to a folder outside the Examples, delete the Examples and verify that all still works.
  2. Please check if after this change, we still need git lfs as a pre-requisite. If no, please remove it from README, and probably we could then also remove the note that the developer may have to re-import the MRTK if issues occur.
  3. Commit the deletion of this directory.
  4. If you want to use the examples later on to be inspired or find some prefabs, please either do it in a separate local project, or if you want to have them in the project folder, gitignore them.
  5. We will also have to remove them from the git history. I think the problematic commit is aed973b. Please refer to @boonwj, he has experience. Maybe he can even perform the pruning this time again.
nielsboecker commented 5 years ago

Update: Removed files and instructions from the active code base in #10. Pruning the files from the git history turned out to be very difficult due to Git LFS, so we will just accept the files being in the git history for now.