Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
trusktr opened this issue Jun 1, 2018 · 6 comments
Closed

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

trusktr opened this issue Jun 1, 2018 · 6 comments

Comments

@trusktr
Copy link

trusktr commented Jun 1, 2018

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
Copy link
Member

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
Copy link
Author

trusktr commented Jun 1, 2018

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
Copy link
Author

trusktr commented Jun 1, 2018

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
Copy link
Member

MarshallOfSound commented Jun 1, 2018

@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 malept changed the title Cool, but Where are the docs for setting the application name? Jun 1, 2018
@malept
Copy link
Member

malept commented Jun 1, 2018

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.

@malept malept closed this as completed Jun 1, 2018
@sparecycles
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants