Skip to content

Commit f513cc8

Browse files
committed
Add CONTRIBUTING
1 parent 5e18fbd commit f513cc8

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Building
4+
5+
### Requirements
6+
7+
1. Windows 10 v1703 build 15063 (Creators Update) or greater
8+
2. Visual Studio 2017
9+
10+
### Steps
11+
12+
1. Clone/fork the repository
13+
2. Open the Signal-Windows.sln in Visual Studio
14+
3. Build the solution
15+
4. Deploy to your target device
16+
17+
## Testing Changes on Signal
18+
19+
### Using Two Devices
20+
21+
With this method it's recommended that you have another device with Signal installed so that you can send messages between your debugging client, typically your desktop, and your other device. It's also recommended that you set up your debugging client to use a [Google Voice](https://www.google.com/voice) number instead of your main phone number. Setup your other device, typically your phone, to use your main phone number. This way you can send messages between your two devices and you don't need to worry about losing important messages on your debugging client.
22+
23+
### Using signal-cli
24+
25+
If you only have your desktop you can use [signal-cli](https://github.com/AsamK/signal-cli) to send messages to your debugging client. You still will need another number to register signal-cli with.
26+
27+
## Backing Up the Database
28+
29+
If you want to backup your database files, `Libsignal.db` and `Signal.db`, you can find them in `C:\Users\<USERNAME>\AppData\Local\Packages\2383BenediktRadtke.SignalPrivateMessenger_teak1p7hcx9ga\LocalCache\`
30+
31+
On mobile these are found at `LocalAppData\2383BenediktRadtke.SignalPrivateMessenger_<VERSION>_arm__teak1p7hcx9ga\LocalCache\`

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ This is an unofficial Signal client for the Universal Windows Platform. It is (c
1919
Found a bug? Great! Open a pull request or an issue.
2020

2121
## Contributing
22-
Contributions fixing bugs or implementing features on the roadmap are welcome.
22+
23+
[See the contributing docs](CONTRIBUTING.md).
2324

2425
# Legal things
2526
## Cryptography Notice

0 commit comments

Comments
 (0)