basic usage replaced with getting started #1004
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've stopped the builds since this is documentation update only. |
|
looking at it now. |
docs/source/getting_started.rst
Outdated
| Getting started | ||
| =============== | ||
|
|
||
| This short guide explains how to get started with `xtensor` once you've installed it with one of |
docs/source/getting_started.rst
Outdated
| Compiling the first example | ||
| --------------------------- | ||
|
|
||
| `xtensor` is a header only library, so there is no library to link with. The only constraint |
docs/source/getting_started.rst
Outdated
| ------------------- | ||
|
|
||
| A better alternative for building programs using `xtensor` is to use `cmake`, especially if you want to | ||
| be able to build on many platforms. Assuming the following folder structure: |
There was a problem hiding this comment.
especially if you are developing for several platforms.
docs/source/getting_started.rst
Outdated
| add_executable(first_example src/example.cpp) | ||
| target_link_libraries(first_example xtensor) | ||
|
|
||
| `cmake` has to know where to find the include headers, this is done through the ``CMAKE_INSTALL_PREFIX`` |
docs/source/getting_started.rst
Outdated
|
|
||
| `cmake` has to know where to find the include headers, this is done through the ``CMAKE_INSTALL_PREFIX`` | ||
| variable. Note that ``CMAKE_INSTALL_PREFIX`` is usually the path to a folder containing the following | ||
| subfolders: ``include``, ``lib`` and ``bin``, so you don't have to pass any additional option for linking. |
There was a problem hiding this comment.
Give examples of prefixes on unix platform (/usr/local).
|
Added a few comments. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @SylvainCorlay