Skip to content

Commit 0221cf4

Browse files
committed
Remove all references to Windows in README
1 parent 4724b48 commit 0221cf4

File tree

1 file changed

+3
-46
lines changed
  • DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/shannonization

1 file changed

+3
-46
lines changed

DirectProgramming/C++SYCL_FPGA/Tutorials/DesignPatterns/shannonization/README.md

+3-46
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ This tutorial describes the process of _Shannonization_ (named after [Claude Sha
33

44
| Optimized for | Description
55
|:--- |:---
6-
| OS | Linux* Ubuntu* 18.04/20.04 <br> RHEL*/CentOS* 8 <br> SUSE* 15 <br> Windows* 10
6+
| OS | Linux* Ubuntu* 18.04/20.04 <br> RHEL*/CentOS* 8 <br> SUSE* 15
77
| Hardware | Intel&reg; Programmable Acceleration Card (PAC) with Intel Arria&reg; 10 GX FPGA <br> Intel&reg; FPGA Programmable Acceleration Card (PAC) D5005 (with Intel Stratix&reg; 10 SX) <br> Intel&reg; FPGA 3rd party / custom platforms with oneAPI support <br> *__Note__: Intel&reg; FPGA PAC hardware is only compatible with Ubuntu 18.04*
88
| Software | Intel® oneAPI DPC++/C++ Compiler
99
| What you will learn | How to make FPGA-specific optimizations to remove computation from the critical path and improve f<sub>MAX</sub>/II
@@ -135,10 +135,7 @@ To achieve an II of 1 for the main `while` loop in the FPGA code shown above, th
135135
> - For system wide installations: `. /opt/intel/oneapi/setvars.sh`
136136
> - For private installations: `. ~/intel/oneapi/setvars.sh`
137137
>
138-
> Windows*:
139-
> - `C:\Program Files(x86)\Intel\oneAPI\setvars.bat`
140-
>
141-
>For more information on environment variables, see **Use the setvars Script** for [Linux or macOS](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-linux-or-macos.html), or [Windows](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-windows.html).
138+
>For more information on environment variables, see **Use the setvars Script** for [Linux or macOS](https://www.intel.com/content/www/us/en/develop/documentation/oneapi-programming-guide/top/oneapi-development-environment-setup/use-the-setvars-script-with-linux-or-macos.html).
142139
143140
144141
### Running Samples in Intel&reg; DevCloud
@@ -198,44 +195,6 @@ To learn more about the extensions and how to configure the oneAPI environment,
198195
```
199196
3. (Optional) As the above hardware compile may take several hours to complete, FPGA precompiled binaries (compatible with Linux* Ubuntu* 18.04) can be downloaded <a href="https://iotdk.intel.com/fpga-precompiled-binaries/latest/shannonization.fpga.tar.gz" download>here</a>.
200197
201-
### On a Windows* System
202-
203-
1. Generate the `Makefile` by running `cmake`.
204-
```
205-
mkdir build
206-
cd build
207-
```
208-
To compile for the Intel&reg; PAC with Intel Arria&reg; 10 GX FPGA, run `cmake` using the command:
209-
```
210-
cmake -G "NMake Makefiles" ..
211-
```
212-
Alternatively, to compile for the Intel&reg; FPGA PAC D5005 (with Intel Stratix&reg; 10 SX), run `cmake` using the command:
213-
214-
```
215-
cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=intel_s10sx_pac:pac_s10
216-
```
217-
You can also compile for a custom FPGA platform. Ensure that the board support package is installed on your system. Then run `cmake` using the command:
218-
```
219-
cmake -G "NMake Makefiles" .. -DFPGA_DEVICE=<board-support-package>:<board-variant>
220-
```
221-
222-
2. Compile the design through the generated `Makefile`. The following build targets are provided, matching the recommended development flow:
223-
224-
* Compile for emulation (fast compile time, targets emulated FPGA device):
225-
```
226-
nmake fpga_emu
227-
```
228-
* Generate the optimization report:
229-
```
230-
nmake report
231-
```
232-
* Compile for FPGA hardware (longer compile time, targets FPGA device):
233-
```
234-
nmake fpga
235-
```
236-
237-
*Note:* The Intel&reg; PAC with Intel Arria&reg; 10 GX FPGA and Intel&reg; FPGA PAC D5005 (with Intel Stratix&reg; 10 SX) do not support Windows*. Compiling to FPGA hardware on Windows* requires a third-party or custom Board Support Package (BSP) with Windows* support.
238-
239198
### Troubleshooting
240199
If an error occurs, you can get more details by running `make` with
241200
the `VERBOSE=1` argument:
@@ -247,7 +206,7 @@ dependencies and permissions errors.
247206
248207
### In Third-Party Integrated Development Environments (IDEs)
249208
250-
You can compile and run this tutorial in the Eclipse* IDE (in Linux*) and the Visual Studio* IDE (in Windows*). For instructions, refer to the following link: [FPGA Workflows on Third-Party IDEs for Intel&reg; oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/articles/technical/intel-oneapi-dpcpp-fpga-workflow-on-ide.html).
209+
You can compile and run this tutorial in the Eclipse* IDE (in Linux*). For instructions, refer to the following link: [FPGA Workflows on Third-Party IDEs for Intel&reg; oneAPI Toolkits](https://www.intel.com/content/www/us/en/developer/articles/technical/intel-oneapi-dpcpp-fpga-workflow-on-ide.html).
251210
252211
## Examining the Reports
253212
This section will walk through how the HTML reports show the result of the optimizations we made in each version of the kernel, the definition of which can be found in `src/IntersectionKernel.hpp`. Start by locating `report.html` in the `shannonization_report.prj/reports/` directory. Open the report in Chrome*, Firefox*, Edge*, or Internet Explorer*. The f<sub>MAX</sub> numbers mentioned in these sections assume that the Arria&reg; 10 GX FPGA is the target. However, the discussion is similar for the Stratix&reg; 10 SX FPGA.
@@ -333,12 +292,10 @@ As a consequence of the fabric architecture of the Intel Stratix&reg; 10 SX FPGA
333292
1. Run the sample on the FPGA emulator (the kernel executes on the CPU):
334293
```
335294
./shannonization.fpga_emu (Linux)
336-
shannonization.fpga_emu.exe (Windows)
337295
```
338296
2. Run the sample on the FPGA device:
339297
```
340298
./shannonization.fpga (Linux)
341-
shannonization.fpga.exe (Windows)
342299
```
343300
344301
### Application Parameters

0 commit comments

Comments
 (0)