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
2ac9f55 doc: Improve cmake instructions in README (Fabian Jahr)
Pull request description:
Minor improvement suggestion for the readme. I find this alternative way of using cmake a bit more comfortable because I don't like to change the directory.
It's just a suggestion based on personal preference, if this is too minor of an improvement feel free to close.
ACKs for top commit:
hebasto:
ACK 2ac9f55.
real-or-random:
utACK 2ac9f55
Tree-SHA512: 5f7bc8b5ff91fb7a115a0e57224c66b018cfc824784e0def1064d07f9be66efe55e1a71e034f6a3d6489e063995c1ae17a9e91c990a0944d600cc957c038909d
Copy file name to clipboardexpand all lines: README.md
+13-14
Original file line number
Diff line number
Diff line change
@@ -64,11 +64,11 @@ Implementation details
64
64
Building with Autotools
65
65
-----------------------
66
66
67
-
$ ./autogen.sh
68
-
$ ./configure
69
-
$ make
70
-
$ make check # run the test suite
71
-
$ sudo make install # optional
67
+
$ ./autogen.sh # Generate a ./configure script
68
+
$ ./configure # Generate a build system
69
+
$ make # Run the actual build process
70
+
$ make check # Run the test suite
71
+
$ sudo make install # Install the library into the system (optional)
72
72
73
73
To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags.
74
74
@@ -79,24 +79,23 @@ To maintain a pristine source tree, CMake encourages to perform an out-of-source
79
79
80
80
### Building on POSIX systems
81
81
82
-
$ mkdir build && cd build
83
-
$ cmake ..
84
-
$ cmake --build .
85
-
$ ctest # run the test suite
86
-
$ sudo cmake --install . # optional
82
+
$ cmake -B build # Generate a build system in subdirectory "build"
83
+
$ cmake --build build # Run the actual build process
84
+
$ ctest --test-dir build # Run the test suite
85
+
$ sudo cmake --install build # Install the library into the system (optional)
87
86
88
-
To compile optional modules (such as Schnorr signatures), you need to run `cmake` with additional flags (such as `-DSECP256K1_ENABLE_MODULE_SCHNORRSIG=ON`). Run `cmake .. -LH` to see the full list of available flags.
87
+
To compile optional modules (such as Schnorr signatures), you need to run `cmake` with additional flags (such as `-DSECP256K1_ENABLE_MODULE_SCHNORRSIG=ON`). Run `cmake -B build -LH` or `ccmake -B build` to see the full list of available flags.
89
88
90
89
### Cross compiling
91
90
92
91
To alleviate issues with cross compiling, preconfigured toolchain files are available in the `cmake` directory.
To cross compile for Android with [NDK](https://developer.android.com/ndk/guides/cmake) (using NDK's toolchain file, and assuming the `ANDROID_NDK_ROOT` environment variable has been set):
0 commit comments