You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update README.md with minor textual improvements
Co-authored-by: Jerry Jacobs <[email protected]>
Co-authored-by: Marcus B Spencer <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ Features include:
13
13
* Optionally starts on login, so you don't need to set up Syncthing as a service.
14
14
* Tray icon syncthing status indicator.
15
15
* Retina ready icons for the Application bundle and status tray.
16
-
* Automatic updates (using [Sparkle](https://sparkle-project.org) pushed from github releases).
16
+
* Automatic updates (using [Sparkle](https://sparkle-project.org) pushed from GitHub Releases).
17
17
* Open shared folders in Finder.
18
-
*Logfile written to `~/Library/Application Support/Syncthing/syncthing.log`, use Finder -> Go -> Go to Folder to open it.
18
+
*Log file written to `~/Library/Application Support/Syncthing/syncthing.log`, use Finder -> Go -> Go to Folder to open it.
19
19
20
20
# Screenshot
21
21
@@ -30,7 +30,7 @@ Currently, OS X 10.13 or higher is necessary. **syncthing-macos** is packaged as
30
30
31
31
To install [just download the dmg](https://github.com/syncthing/syncthing-macos/releases/latest), mount it and drag and drop the application to install. The only necessary configuration is to set the API key and URL when provisioning a remote syncthing instance, the local instance is auto-configured. The `syncthing-macos` application bundle disables the auto-updater of `syncthing` as it has its own update mechanism using [Sparkle](https://sparkle-project.org/).
32
32
33
-
The latest version is available at [Github Releases](https://github.com/syncthing/syncthing-macos/releases/latest), or it can also be installed using [homebrew](https://github.com/Homebrew/homebrew-cask)[`brew install --cask syncthing`](https://formulae.brew.sh/cask/syncthing)
33
+
The latest version is available at [GitHub Releases](https://github.com/syncthing/syncthing-macos/releases/latest), or it can also be installed using [homebrew](https://github.com/Homebrew/homebrew-cask)[`brew install --cask syncthing`](https://formulae.brew.sh/cask/syncthing)
34
34
35
35
# Why
36
36
@@ -41,7 +41,7 @@ All cross-platform approaches are not able to use all the native facilities Appl
41
41
# Goal
42
42
43
43
The goal of this project is to keep the native macOS Syncthing tray lean but usable. No graphs, no advanced configuration
44
-
windows. It just provides a very simple wrapper, so users are not aware syncthing ships as a commandline application. It strives to have a usability of good-by-default and should always follow the [Apple Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/macos) to feel as much as a native application as possible.
44
+
windows. It provides a very simple wrapper, so users may not be aware Syncthing ships as a command line application. It strives to have a usability of good-by-default and should always follow the [Apple Human Interface Guidelines](https://developer.apple.com/design/human-interface-guidelines/macos) to feel as much as a native application as possible.
45
45
46
46
# Known bugs
47
47
@@ -75,7 +75,7 @@ The preferences window is used to point to a local running instance, a remote in
75
75
It is possible to run your own instance and point to it for advanced/development purposes.
76
76
You should only change the settings if you know what you are doing.
77
77
78
-
Setting extra syncthing commandline parameters is a hidden feature. You need to write these using
78
+
Setting extra Syncthing command line parameters is a hidden feature. You need to write these using
79
79
the application defaults configuration. The only current limitation the parameters cannot contain spaces!.
80
80
In the example below the audit log is enabled:
81
81
@@ -147,7 +147,7 @@ git submodule update --init
147
147
- Python 3, for the update-release.py script
148
148
- Needs [semver](https://pypi.org/project/semver/) from pip
149
149
- Cocoapods for updating Objective-C/Swift 3th party dependencies
150
-
- Golang, only needed for Sparkle Github releases to Appcast XML tool
150
+
- Golang, only needed for Sparkle GitHub Releases to Appcast XML tool
151
151
152
152
# Using XCode
153
153
@@ -275,4 +275,4 @@ basicly these steps automatically:
275
275
* When the git branch develop or release pushed to github the Github actions CI server automatically builds debug and release
276
276
* Manually download the release `.dmg` from [github.com actions](https://github.com/syncthing/syncthing-macos/actions/workflows/build-syncthing-macos.yml) which is correctly signed and notarized
277
277
* Manually [create a new Github release](https://github.com/syncthing/syncthing-macos/releases/new) with tag `v<major>.<minor>.<patch>-<bundle index>`
278
-
* Run deployment of Sparkle updater [appcast.xml](https://github.com/syncthing/syncthing-macos/actions/workflows/generate-appcast.yml). Which turns [github releases JSON into a Sparkle appcast.xml file](https://github.com/syncthing/syncthing-macos/tree/develop/cmd/ghreleases2appcast). (See also [Sparkle documentation](https://sparkle-project.org/documentation/)) to push to users.
278
+
* Run deployment of Sparkle updater [appcast.xml](https://github.com/syncthing/syncthing-macos/actions/workflows/generate-appcast.yml). Which turns [GitHub Releases JSON into a Sparkle appcast.xml file](https://github.com/syncthing/syncthing-macos/tree/develop/cmd/ghreleases2appcast). (See also [Sparkle documentation](https://sparkle-project.org/documentation/)) to push to users.
0 commit comments