diff --git a/README.md b/README.md index 04ce099..1b8172a 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,7 @@ make install Some parts of the code significantly benefit from compiler optimizations and platform features such as NEON, SSE and AVX. To enable, use `./configure CFLAGS="-O3 -march=native"` for configuration instead of `./configure`. -For Windows, check out [Windows.md](doc/Windows.md) for compilation and running. -For MacOS, see [macOS.md](doc/macOS.md). +For Windows, MacOS and general build options, please check out [Building.md](doc/Building.md) for compilation and running. ## Running edge as a Service diff --git a/doc/Windows.md b/doc/Building.md similarity index 70% rename from doc/Windows.md rename to doc/Building.md index 5edf60a..263f6d3 100644 --- a/doc/Windows.md +++ b/doc/Building.md @@ -1,3 +1,17 @@ +# n2n on macOS + +In order to use n2n on macOS, you first need to install support for TUN/TAP interfaces: + +```bash +brew tap homebrew/cask +brew cask install tuntap +``` + +If you are on a modern version of macOS (i.e. Catalina), the commands above will ask you to enable the TUN/TAP kernel extension in System Preferences → Security & Privacy → General. + +For more information refer to vendor documentation or the [Apple Technical Note](https://developer.apple.com/library/content/technotes/tn2459/_index.html). + + # Build on Windows ## Requirements @@ -71,3 +85,12 @@ Here is an example `supernode.conf` file: ``` See `edge.exe --help` and `supernode.exe --help` for a list of supported options. + +# General Building Options + +## Low Memory Footprint + +Some parts of the code (well, one for now: Pearson hashing) offer an optional low memory footprint if compiled using with the macro `LOW_MEM_FOOTPRINT`. GCC will make it happen with `-D LOW_MEM_FOOTPRINT` maybe specified along with other options of choice during configuration: + +`./configure CFLAGS="-O3 -march=native -D LOW_MEM_FOOTPRINT"` + diff --git a/doc/macOS.md b/doc/macOS.md deleted file mode 100644 index f3c610e..0000000 --- a/doc/macOS.md +++ /dev/null @@ -1,12 +0,0 @@ -# n2n on macOS - -In order to use n2n on macOS, you first need to install support for TUN/TAP interfaces: - -```bash -brew tap homebrew/cask -brew cask install tuntap -``` - -If you are on a modern version of macOS (i.e. Catalina), the commands above will ask you to enable the TUN/TAP kernel extension in System Preferences → Security & Privacy → General. - -For more information refer to vendor documentation or the [Apple Technical Note](https://developer.apple.com/library/content/technotes/tn2459/_index.html).