Add getting started guide #423
Conversation
|
|
||
| ``` | ||
| include "CXXGraph.hpp" | ||
|
|
||
| using namespace CXXGRAPH; | ||
| ``` | ||
|
|
||
| It's that easy! |
There was a problem hiding this comment.
Sadly, not yet! We haven't created a deployment/combined header that can be simply included into a project. I think @ZigRazor is tracking some work to add that.
There was a problem hiding this comment.
This is true after the installation, @nolankramer can you open an issue to track this missing, or almost misconfigured, installation phase in cmake?
Thank you in advance, I think in any case that this pull request can be merged, you agree?
There was a problem hiding this comment.
If we update the instructions here to specify using CPM (which I use in my own project), this should be mergeable.
For now, using CPM looks like this:
CPMAddPackage("gh:ZigRazor/CXXGraph")
if (CXXGraph_ADDED)
add_library(CXXGraph INTERFACE IMPORTED GLOBAL)
target_include_directories(CXXGraph INTERFACE "${CXXGraph_SOURCE_DIR}/include")
endif()
| include "CXXGraph.hpp" | ||
|
|
||
| using namespace CXXGRAPH; |
There was a problem hiding this comment.
using namespace CXXGRAPH; -> using namespace CXXGraph;
| CXXGRAPH::Node<int> node1("1", 1); | ||
| CXXGRAPH::Node<int> node2("2", 2); |
There was a problem hiding this comment.
CXXGRAPH::Node<int> node1("1", 1);
CXXGRAPH::Node<int> node2("2", 2);
Should be
CXXGraph::Node<int> node1("1", 1);
CXXGraph::Node<int> node2("2", 2);
All the references below should change CXXGRAPH -> CXXGraph
There was a problem hiding this comment.
Yes this is true, @Horicabu can you correct these?
|
I can gladly correct the code samples! |
corrected namespace
|
Good Job I merge it! |
|
@Horicabu after deploy I noticed that there is no possibility to access the making a Graph page from the left side menù. |
Related to #407.
Adds additional documentation to the Docusaurus site that supplements the existing 'How to Use' document and adds in a getting started guide. Revised PR.