Skip to content

[FEATURE REQUEST] Issue #4 [Build & Distribution]: Global Installation Guide & Docsify Update #24

@FatinShadab

Description

@FatinShadab

Describe the feature

Update the project's documentation to reflect the new "Library" status.

  1. Create a "Getting Started" or "Installation" page on the Docsify site.
  2. Update the root README.md with clear instructions on how to use the Makefile and the cstruct.h header.

It should be implemented because

Code is only as good as its documentation. We need to clearly explain how to link the generated libcstruct.a to a user's local project using gcc.

Additional context

Goal:

Bridge the gap between the library code and the end-user.

Files to Modify:

  • README.md
  • _sidebar.md
  • docs/installation.md (New)

Specific Task:

Include a "Troubleshooting" section for common linker errors.

Dependency:

Issue 3 [Build & Distribution]

Would you like to work on this issue?

None

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions