Skip to content

Commit fc648a1

Browse files
authored
The m in macOS is lowercase
Update the use of MacOS to be macOS to match Apple's branding of the operating system.
1 parent 9527015 commit fc648a1

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
ZeroTier Desktop Tray Application and User Interface
22
======
33

4-
This is (as of ZeroTier 1.8) the system tray application and user interface for controlling a local ZeroTier service on Windows, Mac, and (soon) Linux systems.
4+
This is (as of ZeroTier 1.8) the system tray application and user interface for controlling a local ZeroTier service on Windows, macOS, and (soon) Linux systems.
55

66
It runs a very tiny tray application that displays service status, network status, and allows some basic configuration operations, and then launches a system web view container when the user wishes to display a full control panel. The web view dies when this window is closed, so unlike Electron-based or other web technology based system tray apps it does not hog memory while idle.
77

88
Plumbing and tray application glue code is written in Rust. UI control panels are written using [React](https://reactjs.org) and [ElasticUI](https://elastic.github.io/eui/#/).
99

1010
# Building
1111

12-
Only MacOS and Windows are currently supported. Linux may build but there are still outstanding issues. We're working on full Linux support at least for popular Linux desktop environments that support relatively standard tray application APIs.
12+
Only macOS and Windows are currently supported. Linux may build but there are still outstanding issues. We're working on full Linux support at least for popular Linux desktop environments that support relatively standard tray application APIs.
1313

1414
Building the full HTML/JS/CSS UI bundle is a bit cumbersome but is only required if you make changes to the source code or themes under the [ui](ui/) directory. A pre-built copy of the UI is shipped in the repository to make simple builds easier and significantly faster.
1515

16-
## MacOS
16+
## macOS
1717

1818
#### Prerequisites
1919

@@ -23,7 +23,7 @@ Building the full HTML/JS/CSS UI bundle is a bit cumbersome but is only required
2323
* NodeJS (we use the Node package from Homebrew)
2424
* The [yarn](https://yarnpkg.com) package manager for NodeJS.
2525

26-
To build on MacOS you should just be able to type `make` from the project root. If all the necessary dependencies are present it should build a `ZeroTier.app` application in the current directory.
26+
To build on macOS you should just be able to type `make` from the project root. If all the necessary dependencies are present it should build a `ZeroTier.app` application in the current directory.
2727

2828
To rebuild the UI, change into `ui/` and type `yarn install` (this is needed only once) and `yarn build`. As discussed above this is optional and is only needed if you make control panel UI changes.
2929

@@ -37,7 +37,7 @@ To rebuild the UI, change into `ui/` and type `yarn install` (this is needed onl
3737

3838
To build native applications for Windows, just type `make`. This assumes that GNU make, GCC, and Cargo are in your path. The result will be two native EXEs in `target\x86_64-pc-windows-msvc\release` and `target\i686-pc-windows-msvc\release`. We plan to add native support for Windows on ARM64 soon, both for this UI application and for ZeroTier itself.
3939

40-
Building the web bundle part of the UI on Windows has never been done and those tool chains tend to be unfriendly to Windows. We recommend doing `yarn build` stuff in Linux or MacOS. It should work in the Linux subsystem for Windows. As mentioned above we ship this pre-built to make builds easy if you don't need to modify the JavaScript code.
40+
Building the web bundle part of the UI on Windows has never been done and those tool chains tend to be unfriendly to Windows. We recommend doing `yarn build` stuff in Linux or macOS. It should work in the Linux subsystem for Windows. As mentioned above we ship this pre-built to make builds easy if you don't need to modify the JavaScript code.
4141

4242
## Linux, FreeBSD, Other Open Source Desktops
4343

@@ -47,7 +47,7 @@ Building the web bundle part of the UI on Windows has never been done and those
4747

4848
The ZeroTier desktop UI uses forked and slightly modified versions of the following third party code:
4949

50-
* [Tray](https://github.com/zserge/tray) by [Serge Zaitsev](https://github.com/zserge), forked to slightly modify behavior in regard to loop timeouts and Mac application settings. We also manually applied a pull request that fixes builds on ARM64 MacOS. (Retains the MIT license.)
50+
* [Tray](https://github.com/zserge/tray) by [Serge Zaitsev](https://github.com/zserge), forked to slightly modify behavior in regard to loop timeouts and Mac application settings. We also manually applied a pull request that fixes builds on ARM64 macOS. (Retains the MIT license.)
5151
* [Rust web-view](https://github.com/Boscop/web-view) by multiple contributors, forked to modify Mac application behavior and add some custom functionality around copy/paste. (Retains the MIT license.)
5252

5353
Other third party dependencies are included in the normal way. See [Cargo.toml](Cargo.toml) and [ui/package.json](ui/package.json) for these.

0 commit comments

Comments
 (0)