search

lf-lang / vscode-lingua-franca

Lingua Franca extension for Visual Studio Code
Other
6 stars 3 forks source link

update readme #26

Closed housengw closed 2 years ago

housengw commented 2 years ago

include local build instructions in case people cannot find the extension on the market place

petervdonovan commented 2 years ago

This repository is at an awkward moment as we try to prepare the first release. Soon the information in the README will be correct, and the extension will be on the marketplace. Meanwhile, the steps for building locally are provided in CONTRIBUTING.md. Since most users will probably be installing from the marketplace, except for contributors, maybe this information does not need to be in the README.

I'm open for second opinions, though.

lhstrh commented 2 years ago

The information that @housengw added is already available in CONTRIBUTING.md and there is a pointer for that in README.md already. The reason not to include this information so prominently in README.md is that VS Code uses it to display information about the extension. That information is meant for users, not developers. Hence, I think we should not merge this in.