search

electron / forge

:electron: A complete tool for building and publishing Electron applications
https://electronforge.io
MIT License
6.35k stars 497 forks source link

Where are the docs for setting the application name? #515

Closed trusktr closed 6 years ago

trusktr commented 6 years ago

I couldn't find docs on something as simple as defining what an app's name will be for make command. In contrast, electron-builder make it obvious right away, and I don't have to dig through source code.

MarshallOfSound commented 6 years ago

At least for v6 the packager config options are documented in the "Configuration" section of the docs

https://v6.electronforge.io/configuration

Is there a lead in missing there that would point you in that direction?

trusktr commented 6 years ago

For electron-packager, for example, first thing in the usage section:

electron-packager <sourcedir> <appname> --platform=<platform> --arch=<arch> [optional flags...]

and further down in the README:

electron-packager will do the following:

  • Use the current directory for the sourcedir
  • Infer the appname from the productName in package.json

So, just wanted to let you know that even though this looked cool, I chose not to use forge because it purveyed a more difficult experience due to missing some details that are probably very easy to document.

trusktr commented 6 years ago

Ah, well, I clicked on https://electronforge.io on the GitHub page! That may be the cause!

Anywho, this looks awesome, just needed better docs, which I didn't find at first (thanks for showing the new link, you should definitely publish it).

MarshallOfSound commented 6 years ago

@trusktr Ah I see, we're going through a pretty hefty rewrite at the moment which massively addresses things like documentation and getting started even quicker.

If you check out the v6 site you should find it a whole bunch better (and find some cool new features we added in 6)

malept commented 6 years ago

We're going to publish the v6 site when Forge v6 is out of beta.

@MarshallOfSound I wonder if it would be worth adding a small "preview" link to the v6 site from the v5 site.

sparecycles commented 5 months ago

for anyone landing here in 2024 and beyond:

Forge uses electron-packager so the "For electron-packager," example that @trusktr shared is the answer here.