Skip to content

Updates to README.md and Build.md#287

Open
OlekRaymond wants to merge 7 commits intokokkos:developfrom
OlekRaymond:documentation-changes
Open

Updates to README.md and Build.md#287
OlekRaymond wants to merge 7 commits intokokkos:developfrom
OlekRaymond:documentation-changes

Conversation

@OlekRaymond
Copy link
Copy Markdown

The docs for building are currently in two places, I have merged them into one file and attempted to make it read better

Comment thread Build.md
4. Type `make`

5. Specify the generated .dylib file in the environment variable KOKKOS_TOOLS_LIBRARY when running your Kokkos-based application.
2. Type `cmake .. -DCMAKE_INSTALL_PREFIX=${YOUR_KOKKOS_TOOLS_INSTALL_DIR}` and change any options, including tools you want turned on (some are by default off). (Optional)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds fine to me.

Comment thread Build.md Outdated
3. This generates the shared library within that subdirectory.


### Run
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run instructions do not belong to that file

Comment thread Build.md Outdated

3. Type `make`

# With Makefile (recommended)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be updated (not as part of this PR)
We do not recommend using makefiles, we will eventually get rid of them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants