AppImageCommunity / pkg2appimage

Tool and recipes to convert existing deb packages to AppImage
http://appimage.org
MIT License
691 stars 212 forks source link

Documentation missing: AppDir folder structure #33

Closed cookiengineer closed 7 years ago

cookiengineer commented 8 years ago

Hey guys,

I was just trying out AppImages and I have to say that it's a bit mindblowing. I found the AppImageKit guide and it all makes sense, but I have to say that I need some infos to get started. (First-time user, hope that I didn't miss something in the wiki).

Background: I'm the founder of lycheeJS which aims to ship bundles of isomorphic javascript applications (using node, node-sdl, nwjs and electron, and others for mobile).

I am kind of confused about the AppDir structure, can it contain pretty much anything? I was taking a glimpse on some of the Recipes, but I couldn't find clues about what files have to be named in which case.

It would be awesome to have something like an AppDir structure wiki entry that documents something like:

Is there any kind of documentation for that? That's where I'm hanging in my local setup right now. I was also going to ask if there is the possibility of distributing multiple desktop files via AppImageKit?

The only thing I've found so far was the /app.wrapper and the AppImageAssistant.

It would be really neat to have a kind of failsafe hello-world tutorial that just does the basics, clean and simple - so that others can follow up quickly what which tool does.

probonopd commented 8 years ago

For an overview of the AppImage format, please see https://github.com/probonopd/AppImageKit#appimage-format-overview. Then, for instructions on how to create your first AppImage, have a look at https://github.com/probonopd/AppImageKit/wiki/Creating-AppImages, especially the Leafpad "Hello World" example. Inspect the AppDir generated as part of the example.

A small AppDir contains:

Test that you can run AppDir and it executes the app. Then, run the AppDir through AppImageAssistant to wrap it inside an AppImage.