Skip to content

docs: fix clone URL and directory in README setup instructions - #90

Merged
Mythie merged 2 commits into
LibPDF-js:mainfrom
mateuscgoncalves:docs/fix-clone-url
Aug 31, 2026
Merged

docs: fix clone URL and directory in README setup instructions#90
Mythie merged 2 commits into
LibPDF-js:mainfrom
mateuscgoncalves:docs/fix-clone-url

Conversation

@mateuscgoncalves

Copy link
Copy Markdown
Contributor

Problem

If we follow the README steps as written:

git clone https://github.com/libpdf/core.git
cd libpdf

We face two issues:

  1. The clone fails because the repository is under the organization LibPDF-js, not libpdf:
$ git clone https://github.com/libpdf/core.git
Cloning into 'core'...
remote: Repository not found.
fatal: repository 'https://github.com/libpdf/core.git/' not found
  1. Even with the correct URL, git clone creates a core/ directory, so cd libpdf fails as well.

Fix

-git clone https://github.com/libpdf/core.git
-cd libpdf
+git clone https://github.com/LibPDF-js/core.git
+cd core

This is the first command a new contributor runs, so it currently blocks onboarding and contradicts Development Setup section in CONTRIBUTING.md, which already uses LibPDF-js/core and cd core.

Note: this README is also on npm, so the fix will propagate there on the next release

@vercel

vercel Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

@mateuscgoncalves is attempting to deploy a commit to the mythie's projects Team on Vercel.

A member of the Team first needs to authorize it.

@Mythie

Mythie commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Cheers.

@Mythie
Mythie merged commit d1ea1c8 into LibPDF-js:main Aug 31, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants