CXXGraph icon indicating copy to clipboard operation
CXXGraph copied to clipboard

Add a Native Getting Started Guide

Open Horicabu opened this issue 1 year ago • 7 comments
trafficstars

CXXGraph lacks a proper getting started guide in its native documentation, despite comparable guides existing elsewhere on the web.

I would like to contribute a getting started guide for the native documentation.

Horicabu avatar Mar 25 '24 21:03 Horicabu

Good! you can start in a separate README or directly in the new website with docusaurus!

ZigRazor avatar Mar 26 '24 08:03 ZigRazor

A quick question regarding the installation guide.

I cannot seem to get the unix commands to function (I am using MacOS Monterey, for reference). I believe the problem is ambigious syntax in the command template.

$ sudo tar xjf CXXGraph-{version}.tar.bz2

I'm 70% sure there is a specific way one fills in {version} that I am missing and should be in the documentation.

ghost avatar Apr 15 '24 00:04 ghost

@Horicabu you should replace {version} with the release version

ZigRazor avatar Apr 15 '24 06:04 ZigRazor

I gathered as much, but what is the syntax for the command? Perhaps this is a silly question, however I am clearly missing some information. Screen Shot 2024-04-15 at 2 35 44 PM

ghost avatar Apr 15 '24 21:04 ghost

Do you have create the tarball before?

To create a tarball package, execute the following from the command line:

# Enter Packaging Directory
$ cd packaging
# Execute the script to generate tarballs
$ ./tarballs.sh

ZigRazor avatar Apr 16 '24 07:04 ZigRazor

Is the installation guide as provided not a way to download a release version of the project? On my last project, a similar command was used to download a compressed archive (.tar file) from the devs, not the other way around.

I thought packaging was a method to export your own builds that used CXXGraph?

ghost avatar Apr 19 '24 04:04 ghost

should be inserted in the release assets all the compiled package. this could be solution, we can try to add this to the CI/CD workflow

ZigRazor avatar Apr 19 '24 06:04 ZigRazor