search

microsoft / WSL-DistroLauncher

Sample/reference launcher app for WSL distro Microsoft Store packages.
MIT License
1.67k stars 517 forks source link

Please clarify DistroName in "Getting Started" documentation #16

Closed zobelhelas closed 6 years ago

zobelhelas commented 6 years ago

In the "Getting Started" Section the Distro name is note 100% clear to me what you mean. You write:

  1. First of all, pick a Name for your distro. WSL will use this as a key to identify this particular version of your distro - so please try to make it unique! This name should not change from one version of your app to the next. Set this name in MyLinuxDistroLauncher::Initialize, by setting this->_MyName. By default, the value is "MyDistro.1.0"

Either my DistroName is e.g. "Debian GNU/Linux" without a version, or it would be "Debian GNU/Linux 9 (Codename Stretch)". Your example includes a version in the DistroName which you say above shall not change.

khouzam commented 6 years ago

Hi @zobelhelas

This is where it really depends on if you pan to support multiple versions simultaneously,

If you expect to only have 1 debian distro in the store then Debian GNU/Linux is fine. If you think that you might eventually want version 9 and version 10 as separate applications that can be installed independently then you should pick a name that is more specific so that both versions could be identified independently,

zobelhelas commented 6 years ago

Hi @khouzam

How about the above commit to give users more clarity on what is expected?