Skip to content

Commit

Permalink
Add install and build info before first build
Browse files Browse the repository at this point in the history
Signed-off-by: Jan-Christoph Borchardt <[email protected]>
  • Loading branch information
jancborchardt committed Apr 7, 2018
1 parent 6d7fa0b commit 338ddc2
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
39 changes: 32 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,28 @@
<p align="center">
<img src="https://raw.githubusercontent.com/keeporsweep/keeporsweep-desktop/master/images/icon-128.png" height="64">
<h3 align="center">Keep or Sweep</h3>
<p align="center">Randomly clean data off your computer!<p>
<img src="https://raw.githubusercontent.com/keeporsweep/keeporsweep-desktop/master/images/icon-256.png" height="128">
</p>
<h3 align="center">Keep or Sweep</h3>
<p align="center">Randomly clean data off your computer!<p>
<p align="center">
<img src="https://raw.githubusercontent.com/keeporsweep/keeporsweep-desktop/master/images/screenshot.png" height="500">
</p>



## Install

## Info
This is the desktop version for ⊞Windows, 🍏macOS & 🐧Linux. We are still preparing easy-to-launch apps for the platforms. Meanwhile check out the development setup to get the app running.

This is the desktop version for Windows, macOS & Linux. There’s also a [Nextcloud app](https://github.com/keeporsweep/keeporsweep), and more info at [keeporsweep.net](http://keeporsweep.net).
There’s also a [☁️Nextcloud app](https://github.com/keeporsweep/keeporsweep), and more info at [πŸ”€keeporsweep.net](http://keeporsweep.net).

![](images/screenshot.png)


## Installation
## Contribute

Contributions are always welcome! 😍 Check out the [list of issues](https://github.com/keeporsweep/keeporsweep-desktop/issues) and see what you like to contribute.


### Development setup

1. Install the dependencies: We need [Pillow](https://pillow.readthedocs.io/en/latest/installation.html) (Python library for image handling) and [Send2Trash](https://github.com/hsoft/send2trash) (to move files to trash cross-platform instead of permanently removing them). Type these commands in a terminal window:
```
Expand All @@ -22,3 +32,18 @@ pip3 install Send2Trash
```
2. Make `keeporsweep.py` executable by right-click β†’ Properties β†’ Allow executing file as program. (Or in the terminal with `chmod +x keeporsweep.py`)
3. Then place `keeporsweep.py` in any folder and click it! πŸŽ‰ (Or in the terminal run `python3 keeporsweep.py`)


### Building an executable app

1. Install [PyInstaller](https://www.pyinstaller.org/) via terminal:
```
pip3 install pyinstaller
```
2. Then use this command to build the application for your operating system:
```
pyinstaller --name="Keep or Sweep" --onefile --noconsole --icon="images/icon.ico" --clean keeporsweep.py
```
(Use icon.icns when building on macOS)

In case the icon was changed, we need to generate those again. Windows .ico uses the 256px icon and can be saved using [GIMP](https://www.gimp.org/), macOS .icns uses icons ranging from 16px to 1024px and can be generated using [png2icns](https://dentrassi.de/2014/02/25/creating-mac-os-x-icons-icns-on-linux/).
Binary file modified images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion keeporsweep.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/usr/bin/env python3
# πŸ’»πŸ”€πŸ—‘οΈ Keep or Sweep
# πŸ’»πŸ”€πŸ—‘οΈ Keep or Sweep, v0.1.0 for desktop
# Show a random file so you can clean your stuff
# Simply make executable and click (or run as python3 keeporsweep.py)
# http://keeporsweep.net
Expand Down

0 comments on commit 338ddc2

Please sign in to comment.