JuliaGraphs / JuliaGraphs/GraphIO.jl

Is it possible to update the READM file with more example

Open
#61 1 comment 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
62
Forks
30
PR merge metrics
No merged PRs in 30d

Description

For example, it entirely unclear how to load graph6 format files by reading it now.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the README and review the existing format examples and GraphIO.jl usage. Add a clear example showing how to load a graph6 file, including the relevant input and expected result; the README should make this workflow understandable without further investigation.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.