From c451057f3029b5c89a9beefa0e23a7076a812bdf Mon Sep 17 00:00:00 2001 From: Zillode Date: Wed, 6 May 2015 00:35:25 +0200 Subject: [PATCH 1/2] Updated README --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 35dae4ba..8ae6d6d1 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Build Status](http://android.syncthing.net/job/Syncthing-Android/badge/icon)](http://android.syncthing.net/job/Syncthing-Android/) [![tip for next commit](https://tip4commit.com/projects/914.svg)](https://tip4commit.com/github/syncthing/syncthing-android) -A wrapper of [syncthing](https://github.com/syncthing/syncthing) for Android. +A wrapper of [Syncthing](https://github.com/syncthing/syncthing) for Android. screenshot 1 screenshot 2 @@ -32,19 +32,19 @@ To check for updated gradle dependencies, run `gradle dependencyUpdates`. Additi ### Building on Windows -To build the Syncthing app on Windows we need to include the native syncthing binaries: -- Download the `syncthing-linux-386` and `syncthing-linux-arm` archives from [syncthing releases](https://github.com/syncthing/syncthing/releases) and extract them. In each there is a `syncthing` executable. Rename and place both of these to `libs/x86/libsyncthing.so` and `libs/armeabi/libsyncthing.so` respectively. +To build the Syncthing app on Windows we need to include the native Syncthing binaries: +- Download the `syncthing-linux-386` and `syncthing-linux-arm` archives from [Syncthing releases](https://github.com/syncthing/syncthing/releases) and extract them. In each there is a `syncthing` executable. Rename and place both of these to `libs/x86/libsyncthing.so` and `libs/armeabi/libsyncthing.so` respectively. You will also need to replace the standard `build.gradle` file with [this one](https://gist.github.com/Moter8/9cfc191434d1989d86be). ### Development Notes -It is recommended to change the GUI and Listen Address ports for the debug app, eg to 8081 and 22001 respectively. +It is recommended to change the GUI and Listen Address ports for the debug app, eg to 8385 and 22001 respectively. -The syncthing backend used for this android application provides a web interface by default. It can be accessed via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from your development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to access the network of your emulator. Or use the following steps to connect to the single currently running emulator/AVD. +The Syncthing backend used for this android application provides a web interface by default. It can be accessed via the Settings menu -> 'Web GUI'. It is quite helpful to access this web interface from your development machine. Read [android documentation](http://developer.android.com/tools/devices/emulator.html#redirection) on how to access the network of your emulator. Or use the following steps to connect to the single currently running emulator/AVD. - `telnet localhost 5554` -- `redir add tcp:18080:8080` -- Start syncthing app on your emulator and access the web interface from you favorite browser of your development machine via [http://127.0.0.1:18080](http://127.0.0.1:18080) +- `redir add tcp:18384:8384` +- Start Syncthing app on your emulator and access the web interface from you favorite browser of your development machine via [http://127.0.0.1:18384](http://127.0.0.1:18384) # License From 32dba5f0f4763499a4704c11b1f94f00624b79ab Mon Sep 17 00:00:00 2001 From: Zillode Date: Wed, 6 May 2015 00:39:12 +0200 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d544b8a1..c0921d9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,10 @@ Please search for existing issues before opening a new one. ### Where To Report -Issues might be related either to syncthing, syncthing-android or both. The general rule of thumb is this: +Issues might be related either to Syncthing, syncthing-android or both. The general rule of thumb is this: If the issue has to do with synchronization, discovery, the web interface, or can be reproduced on a desktop, it should be posted at [syncthing](https://github.com/calmh/syncthing/issues). -If the issue is related to the Android UI, background service, or can't be reproduced on a desktop running the same syncthing version, it should be posted here. +If the issue is related to the Android UI, background service, or can't be reproduced on a desktop running the same Syncthing version, it should be posted here. For general usage help or questions, you should post to [discourse](http://discourse.syncthing.net/category/support). @@ -29,11 +29,12 @@ syncthing-android version: x.x.x Device name and Android version: -versions of involved syncthing nodes: vx.x.x, ... +versions of involved Syncthing nodes: vx.x.x, ... -logcat: *link to file* (over the entire procedure, limited to the package `com.nutomic.syncthingandroid` if you can, [How to Logcat](http://forum.xda-developers.com/showthread.php?t=1726238), [Logcat in Terminal](http://wiki.cyanogenmod.org/w/Doc:_debugging_with_logcat), [Android Studio Logging Guide](http://stackoverflow.com/a/17648663/1837158)). -config.xml: *link to file* (if it might be related, located in `/data/data/com.nutomic.syncthingandroid`, requires root) +logcat: *link to file*: Use the log window (Settings -> Open Log -> Android Log -> Share) + +config.xml: *link to file* (if it might be related, located in `/data/data/com.nutomic.syncthingandroid`, use the export functionality and fetch the file at /sdcard/backups/syncthing/config.xml) screenshots: *link to file* (only for UI problems)