Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a Native Getting Started Guide #407

Open
Horicabu opened this issue Mar 25, 2024 · 7 comments
Open

Add a Native Getting Started Guide #407

Horicabu opened this issue Mar 25, 2024 · 7 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request website Issue and PR for Website

Comments

@Horicabu
Copy link
Contributor

Horicabu commented Mar 25, 2024

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.

@ZigRazor
Copy link
Owner

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

@ZigRazor ZigRazor added documentation Improvements or additions to documentation enhancement New feature or request website Issue and PR for Website labels Mar 26, 2024
@Horicabu
Copy link
Contributor Author

Horicabu commented Apr 15, 2024

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.

@ZigRazor
Copy link
Owner

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

@Horicabu
Copy link
Contributor Author

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

@ZigRazor
Copy link
Owner

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

@Horicabu
Copy link
Contributor Author

Horicabu commented Apr 19, 2024

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?

@ZigRazor
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request website Issue and PR for Website
Projects
None yet
Development

No branches or pull requests

2 participants