Restore an inadvertently deleted file.

[metze/wireshark/wip.git] / README.cmake

diff --git a/README.cmake b/README.cmake
index 5565144edc9f50342cf1e5a684e4e1ff17767035..24eb8af04e9849dd736427eb6b4a651647b8ec08 100644 (file)
--- a/README.cmake
+++ b/README.cmake
@@ -4,7 +4,7 @@
 
                            Notice
 
-   To find out the current state of the cmake implementaion for
+   To find out the current state of the cmake implementation for
    Wireshark, please take a look at "What needs to be done?" below.
    Basically this is an experiment and if we find out that it works
    and we like cmake more than autofoo we might switch one day.
@@ -55,23 +55,32 @@ Note 4:
   To get predictable results please set umask explicitly.
 
 How to do out of tree build (Win32/64):
-[This is early alpha and while the build should build all executables except
- the GUIs don't waste your time testing unless you are willing to fix things
- yourself]
+[This is advanced alpha and should build all executables except the GTK3
+ Wireshark for 32-bit.]
 1) Follow http://www.wireshark.org/docs/wsdg_html_chunked/ChSetupWin32.html
    Steps 1-9
 1a) Set WIRESHARK_BASE_DIR=c:\wireshark (the parent directory of the
    library directory).
 1b) set WIRESHARK_TARGET_PLATFORM=win32 (or win64)
+1c) set QT5_BASE_DIR=c:\Qt\Qt5.1.1\5.1.1\msvc2010 (or whatever)
+1d) In case you want to use Visual Studio, make sure that the paths
+    to python and cygwin are available to GUI applications.
 2) Install cmake
+2a) Build the zlib library, e.g.
+    cd %WIRESHARK_BASE_DIR%\wireshark-%WIRESHARK_TARGET_PLATFORM%-libs\zlib125
+    cmake -G "NMake Makefiles" . # msbuild will not do because of configuration path
+    cmake --build .
 3) mkdir c:\wireshark\build
 4) cd c:\wireshark\build
-5) cmake -G "NMake Makefiles" -DBUILD_wireshark=OFF path\to\sources
-  (i.e. in case your sources are locaated at c:\wireshark\trunk, use "..\trunk")
+5) cmake -G "NMake Makefiles" path\to\sources
+  (i.e. in case your sources are located at c:\wireshark\trunk, use "..\trunk")
 5a) cmake path\to\sources (this will build for the latest Visual Studio version found)
-6) nmake VERBOSE=1 (or cmake --build . -- VERBOSE=1 )
+6) nmake /X- VERBOSE=1 (or cmake --build . -- VERBOSE=1 )
 6a) Wireshark.sln (this will run up Visual Studio with the cmake built solution
-7)
+   (or use msbuild: cmake --build . -- /p:Configuration=RelWithDebInfo)
+7) In case you want to test the executable(s) inside the build tree:
+   Run setpath.bat whenever it gets updated (there is a message in each cmake
+   run whether it is necessary or not).
 
 Why cmake?
 ==========
@@ -109,7 +118,6 @@ What needs to be done?
 - Add back platform specific objects.
 - Fix places in the cmake files marked as todo.
 - Guides are not installed.
-- Release notes are not built.
 - Build source package (using CPack).
   This is obsolete if we decide to release VCS snapshots instead
 - Build rpm package (using CPack).
@@ -119,6 +127,12 @@ What needs to be done?
 - Add back checkAPI target.
 - Test and add support for other platforms (BSDs, OSX,
   Solaris, Win32, Win64, ...)
+- Add support for cmake configurations.
+- Get plugins loading when running *shark from the build directory.
+- Automatically figure out if *shark is running from the build directory
+  (making WIRESHARK_RUN_FROM_BUILD_DIRECTORY unnecessary like it is with
+  autofoo).
+- Get cross-compilation working (or ensure it does). It works with autofoo.
 ...
 
 Links regarding cmake