1neo works with Linux, and it should work with other POSIX-compliant
2operating systems such as macOS and FreeBSD. Windows is not supported.
3
4The following packages are required to build and run neo:
5
6- autoconf: neo is built using autotools
7- autoconf-archive: required for some of the autoconf checks
8- build-essential: make and g++ are used for compilation
9- libncurses-dev: neo uses ncursesw to control the terminal
10
11You will need to ensure that your C++ compiler supports C++11 and that
12your autoconf version is at least 2.61. g++ and clang++ should both work
13for compilation.
14
15To build neo, run the following shell commands from the main directory:
16
17./autogen.sh
18./configure
19make
20sudo make install
21
22
23For developers, the original author strongly recommends creating a "build"
24directory and running most of the steps from there. The reason is that
25autotools may clutter the "src" directory with build artifacts otherwise.
26The .gitignore might not be ignoring everything that it needs to...
27
28./autogen.sh
29mkdir -p build
30cd build
31make clean make -j3
32sudo make install
33
34
35If you wish to work on neo or debug it, the following configure options
36may help:
37
38./configure CXXFLAGS='-g -O0 -Wall -Werror'
39
40
41Here is a build recipe for users who want a smaller install size.
42In the original author's experience, clang++ produces a slightly smaller
43executable for neo.
44
45./configure CXXFLAGS="-Os -march=native -mtune=native -DNDEBUG -fno-exceptions -ffunction-sections -fdata-sections -flto" LDFLAGS="-Wl,--gc-sections -flto" CXX="clang++"
46make -j3
47sudo make install-strip
48
49
50To uninstall neo, run the following command from the directory where you built neo:
51
52sudo make uninstall
53
54neo can also be manually uninstalled by simply deleting the installed neo executable and neo.6 man page.
55