Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

Commit 69b9f63

Browse files
committed
Update readme.md
1 parent 34ba709 commit 69b9f63

File tree

1 file changed

+15
-31
lines changed

1 file changed

+15
-31
lines changed

readme.md

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,34 @@
1-
# WhatsUpp [![Build Status](https://travis-ci.com/alindt/WhatsUpp-PRIVATE.svg?branch=master)](https://travis-ci.com/alindt/WhatsUpp-PRIVATE)
1+
# WhatsUpp [![CircleCI](https://circleci.com/gh/alindt/WhatsUpp/tree/master.svg?style=svg&circle-token=ee4ce35cba209e8d63e4df51ae5545468820e0ef)](https://circleci.com/gh/alindt/WhatsUpp/tree/master) [![CodeFactor](https://www.codefactor.io/repository/github/alindt/whatsupp/badge/master)](https://www.codefactor.io/repository/github/alindt/whatsupp/overview/master) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) ![libraries.io](https://img.shields.io/librariesio/github/alindt/WhatsUpp.svg)
22

3-
Native desktop app/wrapper for https://web.whatsapp.com. Built with [Electron](https://electronjs.org/).
3+
Linux native desktop app/wrapper for https://web.whatsapp.com. Built with [Electron](https://electronjs.org/).
44
This project continues the work of [@Enrico204](https://github.com/Enrico204/Whatsapp-Desktop) and [@bcalik](https://github.com/bcalik/Whatsapp-Desktop)
55

66
## Features
77

8-
* Cross platform (OSX, Windows x64, Linux x32/x64 and ARM v7l)
8+
* ~Cross platform (OSX, Windows x64, Linux x32/x64 and ARM v7l)~ Linux only (ia32/amd64)
99
* Native notifications
1010
* System tray icon
1111
* Open links in default browser
12-
* Badge with the number of notifications in the dock/taskbar
12+
* Badge with the number of notifications in the tray/dock/taskbar
1313
* Dock icon bounces when a new message is received
14-
* Focus on contact search input via (CTRL/CMD/WIN)+F
15-
* Phone info window (s/w versions, battery status, etc)
14+
* Focus on contact search input via CTRL+F
15+
* ~Phone info window (s/w versions, battery status, etc)~ FIX NEEDED
1616
* Auto-launch on login
1717
* Start minimized to tray icon
1818
* Logging system (log to console and *userData*/log.log)
1919
* Apply custom CSS stylesheet
20-
* Auto-hide menu bar (Windows, Linux)
20+
* Auto-hide menu bar
2121
* Disabling GPU rendering (useful when dealing with bugged video drivers)
2222
* A couple of things can be configured:
2323
* Toggle avatar visibility
2424
* Toggle preview of the messages visibility
2525
* Set the size for the media thumbs
2626
* Proxy settings for connection
2727

28-
## Repositories
29-
30-
### TODO
31-
3228
## Command line switches
3329

3430
--debug-log Switch file's log level to "debug" (default: "warn")
3531

36-
## Known issues
37-
38-
### Fonts rendering as rectangles after upgrade
39-
40-
Apparently it's caused by an issue of Electron with an older version of Pango. Upgrade Pango at least to `1.40.12` or downgrade to `1.40.5` should fix this. See https://github.com/Enrico204/Whatsapp-Desktop/issues/13
41-
42-
### Tray Icon is displayed wrong in KDE
43-
44-
This is due to some bugs between Electron and KDE on tray icons, see [this comment on issue #27](https://github.com/Enrico204/Whatsapp-Desktop/issues/27#issuecomment-338410450) and [vector-im/riot-web#3133](https://github.com/vector-im/riot-web/issues/3133). A workaround is to uninstall `libappindicator` and `libappindicator-gtk3` packages (this will change also the behavior of click on the tray icon).
45-
4632
## Contributions
4733

4834
Contributions are welcome! For feature requests and bug reports please submit an [issue](https://github.com/alindt/WhatsUpp/issues).
@@ -53,23 +39,21 @@ To build from the source, run the following commands:
5339

5440
```
5541
yarn install
56-
yarn run build:platform
42+
yarn build:$platform
5743
```
5844

59-
where `build:platform` can be `build:linux` if you want to build for Linux (use `build:linux32` for 32-bit), `build:osx` for OSX only, `build:win` for Windows only, or simply `build` to build for all platforms.
45+
where `$platform` can be one of `linux32`, `linux64` or `linux` (builds both).
6046

61-
You'll find artifacts into `dist/` directory.
47+
You'll find artifacts in the `./dist/` directory.
6248

6349
## Run on-the-fly (for devs)
6450

65-
If you're a developer, you may want to use directly `yarn run dev` (in project root) instead of compiling the code each time. Please note that autostart feature will not work in this mode.
66-
67-
### Cross-build for Windows (from Linux/macOS)
51+
Run `yarn dev` (in project root) instead of compiling the code each time.
6852

69-
Wine needs to be installed. On macOS, it is installable via Homebrew:
53+
## Buy me a beer!
7054

71-
brew install wine
55+
If you find this project useful consider buying me a beer :)
7256

73-
On GNU/Linux you can install `wine` from your distro package manager.
57+
[![Donate](https://liberapay.com/assets/widgets/donate.svg)](https://liberapay.com/alindt/donate)
58+
[![Donate](https://www.paypalobjects.com/digitalassets/c/website/marketing/apac/C2/logos-buttons/optimize/26_Blue_PayPal_Pill_Button.png)](https://paypal.me/alintraistaru)
7459

75-
Please mind that `wine` requires an Xorg display, so you should set correctly your DISPLAY env var (you can use `Xvfb` if you don't have/want a real Xorg display running)

0 commit comments

Comments
 (0)