comparison Samples/README.md @ 1378:5b750a4e1b52 broker

Doc for SDL sample
author Benjamin Golinvaux <bgo@osimis.io>
date Wed, 22 Apr 2020 14:02:34 +0200
parents a3b453a833e2
children 62dc0d737e7b
comparison
equal deleted inserted replaced
1377:458ab069f313 1378:5b750a4e1b52
18 18
19 Orthanc can be retrieved with: 19 Orthanc can be retrieved with:
20 ``` 20 ```
21 hg clone https://hg.orthanc-server.com/orthanc 21 hg clone https://hg.orthanc-server.com/orthanc
22 ``` 22 ```
23
24 Furthermore, the samples usually assume that an Orthanc is running locally,
25 without authentication, on port 8042. The samples can easily be tweaked if
26 your setup is different.
27
28 When Dicom resources are to be displayed, their IDs can be supplied in the
29 various ways suitable for the platform (command-line arguments, URL parameters
30 or through the GUI)
31
23 32
24 WebAssembly samples 33 WebAssembly samples
25 =================== 34 ===================
26 35
27 Building the WebAssembly samples require the Emscripten SDK 36 Building the WebAssembly samples require the Emscripten SDK
123 132
124 I suggest that you do *not* use the `Debug` confirmation unless you really 133 I suggest that you do *not* use the `Debug` confirmation unless you really
125 need it, for the additional checks that are made will lead to a very long 134 need it, for the additional checks that are made will lead to a very long
126 build time and much slower execution (more severe than with a native non-wasm 135 build time and much slower execution (more severe than with a native non-wasm
127 target) 136 target)
137
138 Native samples
139 =================
140
141 SdlSimpleViewer
142 ---------------
143
144 ### Windows build
145
146 Here's how to build the SdlSimpleViewer example using Visual Studio 2019
147 (the shell is Powershell, but the legacy shell can also be used with some
148 tweaks). This example is meant to be launched from the folder above
149 orthanc-stone.
150
151 ```
152 # create the build folder and navigate to it
153 $buildDir = "build-stone-sdlviewer-msvc16-x64"
154
155 if (-not (Test-Path $buildDir)) {
156 mkdir -p $buildDir | Out-Null
157 }
158
159 cd $buildDir
160
161 # perform the configuration
162 cmake -G "Visual Studio 16 2019" -A x64 `
163 -DMSVC_MULTIPLE_PROCESSES=ON `
164 -DALLOW_DOWNLOADS=ON `
165 -DSTATIC_BUILD=ON `
166 -DOPENSSL_NO_CAPIENG=ON `
167 ../orthanc-stone/Samples/Sdl/SimpleViewer
168
169 $solutionPath = ls -filter *.sln
170 Write-Host "Solution file(s) available at: $solutionPath"
171 ```
172
173 The initial configuration step will be quite lengthy, for CMake needs to
174 setup its internal cache based on your environment and build tools.
175
176 Subsequent runs will be several orders of magnitude faster!
177
178 One the solution (.sln) file is ready, you can open it using the Visual Studio
179 IDE and choose Build --> Build solution.
180
181 An alternative is to execute `cmake --build .` in the build folder created by
182 the script.
183