CXXGraph icon indicating copy to clipboard operation
CXXGraph copied to clipboard

Add Some example in the "Example" Section of the README.md

Open ZigRazor opened this issue 4 years ago • 7 comments

Please add some good example in the Example Section. The desired is that there is the basic example of use of the library and then subsection for each algorithm. Please add also a good explanation for example code.

ZigRazor avatar Oct 13 '21 07:10 ZigRazor

Please assign me this issue

samyaksand avatar Oct 13 '21 09:10 samyaksand

Yes, i assign it to you! @samyaksand

ZigRazor avatar Oct 13 '21 09:10 ZigRazor

@samyaksand are you working on this?

ZigRazor avatar Oct 15 '21 08:10 ZigRazor

Yes

samyaksand avatar Oct 15 '21 10:10 samyaksand

@samyaksand are you still working on this?

ZigRazor avatar Jan 27 '22 08:01 ZigRazor

Hi @ZigRazor

The desired is that there is the basic example of use of the library and then subsection for each algorithm.

  • Do you mean code snippets from the /examples/ folder?

My first tought was an example where the graph nodes are coordinates and the graph edges are possible routes with different weights, where weights will mean the traffic intensity and showcase best route suggestions using different algorithms.

How do you feel about that?

TSMotter avatar Apr 11 '24 11:04 TSMotter

It could be good. Remember ther rule: "write in the documentation what you expect to find in a documentation if you are the user"

ZigRazor avatar Apr 11 '24 12:04 ZigRazor