Add a lil' readme, as a treat

blood
Adasauce 4 years ago
parent c19d6261b5
commit f8148897ed
Signed by: adasauce
GPG Key ID: B4FD3151235211CB
  1. 38
      README.md

@ -1,3 +1,39 @@
# mknative
some wrappers around nativefier, mostly for my own use.
Some wrappers around nativefier.
## Installation
```
make install
```
note: make sure `~/.local/bin` is in your `$PATH`
## Generating apps
```
mknative -n example-app -s https://example.com
```
it will look for an example-app.png file in `~/.local/share/mknative/icons/`.
Just download the icon for the site and place it there before running.
Then check out your application launcher for example-app.
## Uninstalling apps
```
mknative -u -n $name
```
## Contributing
I'd like to know if it works for you, or if it's broken somehow.
I'm not looking to create a giant repository of icons, the official nativefier repo on
github has a ton of them for common sites. Please don't open issues and pull requests to
add them.
It would be really handy if there were a little script that pulled down the icons as part
of the `mknative` build step to avoid the manual process of fetching and placing an icon.

Loading…
Cancel
Save