enoch/n2n
1
0
Fork 0
mirror of https://github.com/ntop/n2n.git synced 2024-09-19 16:41:11 +02:00
Code Issues Actions Packages Projects Releases 1 Wiki Activity

merged additional building information

Browse Source
This commit is contained in:
Logan007 2020-08-16 01:46:35 +05:45
parent 052127734e
commit bbcce17b77
3 changed files with 24 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -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`. 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 Windows, MacOS and general build options, please check out [Building.md](doc/Building.md) for compilation and running.
For MacOS, see [macOS.md](doc/macOS.md).
## Running edge as a Service ## Running edge as a Service

23
doc/Windows.md → doc/Building.md
View File

@ -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 # Build on Windows
## Requirements ## 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. 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"`

12
doc/macOS.md
View File

@ -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).