search

alefragnani / vscode-whats-new

VS Code submodule for a What's New page
MIT License
28 stars 7 forks source link

[FEATURE] Add information on how to use the submodule on your extension #34

Closed DarkTrick closed 3 years ago

DarkTrick commented 3 years ago

Feature Request:

Could you add detailed information on how to work on the extension?

My first hurdle was to figure out, that git clone wouldn't clone the whats-new section. And even after that I couldn't get it to run

Background / Details:

In regard of this issue, I thought, I'd look into your code base. But I have troubles debugging your extension. Apparently it has troubles finding the what's new section.

Activating extension 'alefragnani.separators' failed: Cannot find module '../../vscode-whats-new/src/Manager'.
alefragnani commented 3 years ago

Hi @DarkTrick ,

This repo is a Git submodule, so you must run the commands git provides to initialize them, after you cloned extension which uses this submodule.

It seems you tried to build the Separators extension. This extension (just like all my other extension) has no special step, other than those described in VS Code documentation/samples.

To sum up, after you cloned the Separators extension, you just have to run two additional commands:

    git submodule init
    git submodule update

Doing so, this What’s New submodule will be available on your file system.

Hope this helps