search

LinusU / node-appdmg

💾 Generate your app dmgs
MIT License
1.7k stars 152 forks source link

Docs/property requirements #100

Closed cstruct closed 8 years ago

LinusU commented 8 years ago

Doesn't it feel like the entire window object is required now though?

LinusU commented 8 years ago

This branch has conflicts that must be resolved

Sorry about that 💃

cstruct commented 8 years ago

@LinusU, I changed the spec to MSON. What do you think?

LinusU commented 8 years ago

To be honest, I don't love it :)

Especially when viewing it as rendered markdown it doesn't look too good. Maybe we should have a "quick start" example in JSON, and then document all the options in detail further down?

LinusU commented 8 years ago

Minimal quick start example:

{

  // The title of the produced DMG, which will be shown when mounted
  "title": "Test Title",

  // Path to your icon, which will be shown when mounted
  "icon": "TestIcon.icns",

  // Path to your background
  "background": "TestBkg.png",

  "contents": [

    // This is the contents of your DMG.

    // Each entry has a position specified by
    // X and Y in the center of its icon.

    // `type: link` creates a link to the specified target
    { "x": 448, "y": 344, "type": "link", "path": "/Applications" },

    // `type: file` adds a file to the DMG
    { "x": 192, "y": 344, "type": "file", "path": "TestApp.app" }

  ]

}
cstruct commented 8 years ago

@LinusU Updated to use a working JSON example and a simplified MSON (without value examples and all keys qouted).

LinusU commented 8 years ago

Looking awesome 🙌 LGTM