From 1406712ce0f8334c866fe96e7dee0e95be81d022 Mon Sep 17 00:00:00 2001 From: bwt Date: Sat, 1 Feb 2020 06:14:36 -0500 Subject: [PATCH] More descriptive README --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8295d3e..9013d0e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # nativefier-apps -Automated nativefier building of web applications \ No newline at end of file +Automated nativefier building of web applications + +## To use: + +- Choose a project name +- Create the directories `desktops`, `icons`, `injects`, and `urls`. +- You must at least create a text file in `urls` named `.url` that contains the URL of the web page you want to turn into an app. +- Nativefier will use the site's `favicon` for the created app. If you want a different icon, put a `.png` into `icons` +- Macs must use `.icns` for icons. The `generate-icns` script will convert `.png` files to `.icns` +- If you would like to modify the site, you can inject CSS and JS by placing `.css` or `.js` into `injects` +- For Linux, if you would like to provide a `.desktop` file, place `.desktop` into the `desktops` directory +- If you would like to make Windows apps on Linux, make sure `wine` is installed