bennymeg / nx-electron

Electron schematics for nrwl nx platform
Apache License 2.0
328 stars 85 forks source link

Better docs #157

Closed dhrn closed 2 years ago

dhrn commented 2 years ago

Is your feature request related to a problem? Please describe. It is difficult to work with the repo, a lot options are not having the docs. please if possible add some docs to work with the repo.

(couldn't run the code base in the Linux machine)

Describe the solution you'd like please include an example app and possible override options. May be host the docs in the github pages

bennymeg commented 2 years ago

The packager side is well documented here.

The Nx options side could be viewed by appending --help to each command, it will state and explain all the available options for the requested command (as stated in the docs). For ease of use, I recommand using the nx-console plugin, it will make using the plugin intuitively.

All the rest (including this explanation) is documents under the repo docs.