Getting Started Guide: Linux #17
Conversation
|
I just noticed while reviewing the CI logs, the new file's extension is repeated. |
There was a problem hiding this comment.
This is a nice guide, but I wonder if it is a little too complicated for a "getting started" guide.
An OpenCL fan has been contributing basic "setup" docs to my SimpleOpenCLSamples repo for a while now. Here's an example for Ubuntu 18.04:
https://github.com/bashbaug/SimpleOpenCLSamples/blob/master/docs/env/ubuntu/18.04.md
It heavily leverages the Ubuntu packages for OpenCL headers / libs / etc. These are admittedly a bit old, but they have the advantage of being super easy for novice users to install and are usually sufficient to build and run "my first OpenCL application".
How do you feel about having one "getting started" doc that uses OS packages to get up and running as quickly and easily as possible, and a different "getting start" doc like this one that generates an up-to-date environment built on the SDK? They could even be two different sections of the same doc, if desired.
chapters/getting_started_linux.md
Outdated
| - The C and optionally the C++ headers | ||
| - An Installable Client Driver (ICD) Loader | ||
| - Shared objects library (libOpenCL.so) | ||
| - Export library (libOpenCL.a) |
There was a problem hiding this comment.
On Linux a separate export library is not needed and the same libOpenCL.so is used for both purposes.
There was a problem hiding this comment.
Yes, that was a mistake from our part. Fixed.
chapters/getting_started_linux.md
Outdated
| Another popular choice is the usage of `Clang` compiler, based on intermediate representation of the C-like languages on `LLVM` (originally Low Level Virtual Machine). To use it open your favorite shell in your favorite terminal and run: | ||
|
|
||
| ``` bash | ||
| sudo apt install clang -y | ||
| ``` | ||
|
|
||
| This will install `Clang 10` and `LLVM 10`. |
There was a problem hiding this comment.
I'd consider removing this section (and any other mention of Clang) entirely. While I'm a fan of Clang, I think this is unnecessary to create a "minimal and productive environment" and as far as I can tell no part of this guide uses Clang.
chapters/getting_started_linux.md
Outdated
| If you do not have CMake installed yet, we'll install it, as it's the primary supported build system, and it will make our builds much simpler. Open your favorite shell in your favorite terminal and run: | ||
|
|
||
| ``` bash | ||
| sudo apt install cmake ninja-build -y |
There was a problem hiding this comment.
Note, no part of this guide uses ninja.
Co-authored-by: Chris Eich <ceich62@gmail.com>
|
@bashbaug I added dropdown menus to the various ways of obtaining the headers/lib and how to build on the command-line in each case, but left uncollapsed by default only the the simplest way: APT. I left GitHub and Vcpkg there for those interested in those ways as well, but they're somewhat "out of sight, out of mind" and don't clutter the straightforward way. Does that seem like something acceptable? I also went ahead and removed the VS Code part because it was way too brief compared to the depth, so I will write a separate document which we can link from the end of both the Windows and Linux guide some other time. |
This is a getting started guide focusing on Ubuntu, the distro of choice for Linux.