49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
# Whisper
|
|
|
|
Whisper is a client for signald. In combination, the two represent a complete replacement for the official Signal desktop client. Additionally, Whisper and Signald can be run on any mobile device supporting the Java Runtime Environment.
|
|
|
|
**Whisper is in early stages of development.**
|
|
|
|
## Installation
|
|
|
|
Currently: use lein run
|
|
TODO: package, wrap with a nice makefile
|
|
|
|
## Usage
|
|
|
|
Call `lein run` in a freshly cloned repository to run Whisper. Make sure Signald is already running.
|
|
|
|
FIXME: explanation
|
|
|
|
$ java -jar whisper-0.1.0-standalone.jar [args]
|
|
|
|
## Options
|
|
|
|
FIXME: listing of options this app accepts.
|
|
|
|
## Examples
|
|
|
|
...
|
|
|
|
### Bugs
|
|
|
|
...
|
|
|
|
### Any Other Sections
|
|
### That You Think
|
|
### Might be Useful
|
|
|
|
## License
|
|
|
|
Copyright © 2019 Aidan Hahn
|
|
|
|
This program and the accompanying materials are made available under the
|
|
terms of the Eclipse Public License 2.0 which is available at
|
|
http://www.eclipse.org/legal/epl-2.0.
|
|
|
|
This Source Code may also be made available under the following Secondary
|
|
Licenses when the conditions for such availability set forth in the Eclipse
|
|
Public License, v. 2.0 are satisfied: GNU General Public License as published by
|
|
the Free Software Foundation, either version 2 of the License, or (at your
|
|
option) any later version, with the GNU Classpath Exception which is available
|
|
at https://www.gnu.org/software/classpath/license.html.
|