Build instructions of TypeScript

[appleiifanclub]

Acknowledgement

• I acknowledge that issues using this template may be closed without further explanation at the maintainer's discretion.

Comment

Is there any Build instructions of TypeScript from GitHub source ?

[MartinJohns]

Clone, install dependencies, run build script.

[wyatt-wong]

Clone, install dependencies, run build script.

What about an update to the README.md to show which dependencies to install and the command line to run the build script ?

I am NOT expert in both npm and node.js.

[rubiesonthesky]

Did you check CONTRIBUTING.md which usually has this kind of instructions? https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md

[appleiifanclub]

Did you check CONTRIBUTING.md which usually has this kind of instructions? https://github.com/microsoft/TypeScript/blob/main/CONTRIBUTING.md

I have checked the CONTRIBUTING.md but I couldn't find which section is about "Building Instructions", nor am I sure which section you are referring me to look out in such a large document.

However, if someone could simply provide me the DIRECT answer that it would be perfect. Otherwise I think it will continue to raise even more issues than solving it.

[RyanCavanaugh]

This is documented and you can search for the word "build" in the file you linked there.

This is a complex project and a lot of actual reading is going to be required; skimming alone is not going to be sufficient.

[appleiifanclub]

This is documented and you can search for the word "build" in the file you linked there.

This is a complex project and a lot of actual reading is going to be required; skimming alone is not going to be sufficient.

The building instruction should be separated out instead of buried inside the CONTRIBUTING.md

[MartinJohns]

You really can't have it more easily accessible than the scripts already provide:
https://github.com/microsoft/TypeScript/blob/main/package.json#L93-L95

What about an update to the README.md to show which dependencies to install and the command line to run the build script ?

I am NOT expert in both npm and node.js.

@wyatt-wong It's questionable why you would even compile the compiler if you don't even know the bare minimum basics of the ecosystem. Installing dependencies and checking the scripts section of your package.json is like the 101 of JavaScript projects.