mirror of
https://github.com/Llewellynvdm/nativefier.git
synced 2024-12-31 21:21:52 +00:00
README: attempt to be more concise, using gh "details" feature
This commit is contained in:
parent
c0210265ab
commit
c9c81f5583
95
README.md
95
README.md
@ -41,6 +41,37 @@ Optional dependencies:
|
|||||||
- [Wine](https://www.winehq.org/) to build Windows apps from non-Windows platforms.
|
- [Wine](https://www.winehq.org/) to build Windows apps from non-Windows platforms.
|
||||||
Be sure `wine` is in your `$PATH`.
|
Be sure `wine` is in your `$PATH`.
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Nativefier is also installable with Docker (click to expand)</summary>
|
||||||
|
|
||||||
|
- Pull the image from [Docker Hub](https://hub.docker.com/r/nativefier/nativefier): `docker pull nativefier/nativefier`
|
||||||
|
- ... or build it yourself: `docker build -t local/nativefier .`
|
||||||
|
(in this case, replace `nativefier/` in the below examples with `local/`)
|
||||||
|
|
||||||
|
By default, `nativefier --help` will be executed.
|
||||||
|
To build e.g. a Gmail app into `~/nativefier-apps`,
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run --rm -v ~/nativefier-apps:/target/ nativefier/nativefier https://mail.google.com/ /target/
|
||||||
|
```
|
||||||
|
|
||||||
|
You can pass Nativefier flags, and mount volumes to pass local files. E.g. to use an icon,
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://web.whatsapp.com/ /target/
|
||||||
|
```
|
||||||
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Nativefier is also installable from Snap & AUR (click to expand)</summary>
|
||||||
|
|
||||||
|
These repos are *not* managed by Nativefier maintainers; use at your own risk.
|
||||||
|
If using them, for your security, please inspect the build script.
|
||||||
|
|
||||||
|
- [Snap](https://snapcraft.io/nativefier)
|
||||||
|
- [AUR](https://aur.archlinux.org/packages/nodejs-nativefier)
|
||||||
|
</details>
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
To create a desktop app for medium.com, simply `nativefier 'medium.com'`
|
To create a desktop app for medium.com, simply `nativefier 'medium.com'`
|
||||||
@ -55,39 +86,10 @@ to learn about command-line flags usable to configure your app.
|
|||||||
To have high-quality icons used by default for an app/domain, please
|
To have high-quality icons used by default for an app/domain, please
|
||||||
contribute to the [icon repository](https://github.com/nativefier/nativefier-icons).
|
contribute to the [icon repository](https://github.com/nativefier/nativefier-icons).
|
||||||
|
|
||||||
### Catalog
|
### Troubleshooting
|
||||||
|
|
||||||
See [CATALOG.md](CATALOG.md) for build commands & workarounds contributed by the community.
|
See [CATALOG.md](CATALOG.md) for site-specific ideas & workarounds contributed by the
|
||||||
|
community, and search in [existing issues](https://github.com/nativefier/nativefier/issues).
|
||||||
## Docker
|
|
||||||
|
|
||||||
Nativefier is also usable from Docker:
|
|
||||||
|
|
||||||
- Pull the image from [Docker Hub](https://hub.docker.com/r/nativefier/nativefier): `docker pull nativefier/nativefier`
|
|
||||||
- ... or build it yourself: `docker build -t local/nativefier .`
|
|
||||||
(in this case, replace `nativefier/` in the below examples with `local/`)
|
|
||||||
|
|
||||||
By default, `nativefier --help` will be executed.
|
|
||||||
To build e.g. a Gmail app into `~/nativefier-apps`,
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm -v ~/nativefier-apps:/target/ nativefier/nativefier https://mail.google.com/ /target/
|
|
||||||
```
|
|
||||||
|
|
||||||
You can pass Nativefier flags, and mount volumes to pass local files. E.g. to use an icon,
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run --rm -v ~/my-icons-folder/:/src -v $TARGET-PATH:/target nativefier/nativefier --icon /src/icon.png --name whatsApp -p linux -a x64 https://web.whatsapp.com/ /target/
|
|
||||||
```
|
|
||||||
|
|
||||||
## Unofficial repositories
|
|
||||||
|
|
||||||
Nativefier is also available in various user-contributed software repos.
|
|
||||||
These are *not* managed by Nativefier maintainers; use at your own risk.
|
|
||||||
If using them, for your security, please inspect the build script.
|
|
||||||
|
|
||||||
- [Snap](https://snapcraft.io/nativefier)
|
|
||||||
- [AUR](https://aur.archlinux.org/packages/nodejs-nativefier)
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@ -97,31 +99,4 @@ Help welcome on [bugs](https://github.com/nativefier/nativefier/issues?q=is%3Aop
|
|||||||
Docs: [Developer / build / hacking](HACKING.md), [API / flags](API.md),
|
Docs: [Developer / build / hacking](HACKING.md), [API / flags](API.md),
|
||||||
[Changelog](CHANGELOG.md).
|
[Changelog](CHANGELOG.md).
|
||||||
|
|
||||||
## License
|
License: [MIT](LICENSE.md).
|
||||||
|
|
||||||
[MIT](LICENSE.md).
|
|
||||||
|
|
||||||
## Troubleshooting
|
|
||||||
|
|
||||||
Generally, see [CATALOG.md](CATALOG.md) for ideas & workarounds, and search in
|
|
||||||
[existing issues](https://github.com/nativefier/nativefier/issues).
|
|
||||||
|
|
||||||
### Old/unsupported browser
|
|
||||||
|
|
||||||
Some sites intentionally block Nativefier (or similar) apps, e.g. [Google](https://github.com/nativefier/nativefier/issues/831) and [WhatsApp](https://github.com/nativefier/nativefier/issues/1112).
|
|
||||||
|
|
||||||
First, try setting the [`--user-agent`](https://github.com/nativefier/nativefier/blob/master/API.md#user-agent) to `firefox` or `safari`.
|
|
||||||
If still broken, see [CATALOG.md](CATALOG.md) + existing issues.
|
|
||||||
|
|
||||||
### Videos won't play
|
|
||||||
|
|
||||||
This issue comes up for certain sites like [HBO Max](https://github.com/nativefier/nativefier/issues/1153) and [Udemy](https://github.com/nativefier/nativefier/issues/1147).
|
|
||||||
|
|
||||||
First, try [`--widevine`](API.md#widevine).
|
|
||||||
If still broken, see [CATALOG.md](CATALOG.md) + existing issues.
|
|
||||||
|
|
||||||
### Settings cached between app rebuilds
|
|
||||||
|
|
||||||
This can occur because app cache lives separate from the app.
|
|
||||||
|
|
||||||
Try delete your app's cache, which is found at `<your_app_name_lower_case>-nativefier-<random_id>` in your OS's "App Data" directory (for Linux: `$XDG_CONFIG_HOME` or `~/.config` , for MacOS: `~/Library/Application Support/` , for Windows: `%APPDATA%` or `C:\Users\yourprofile\AppData\Roaming`)
|
|
||||||
|
Loading…
Reference in New Issue
Block a user