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

Update README #171

Closed
wants to merge 5 commits into from
Closed

Update README #171

wants to merge 5 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Oct 17, 2020

Some remarks:

  • GitHub-markdown changed, or some code-blocks in the README were always broken. Syntax-highlighting was added (only some blocks had it).
  • Replaced URLs with new equivalents. For gh-pages, GitHub prefers github.io now. This also affects the homepage URL in the project sidebar, which should be updated by @benvanik.
    I believe this might actually fix Directly use embed.js failed, try loading core/lib/gli.js, but gli.js isn't there? #167 .
    (I had the same issue a couple of days ago, but don't remember how I resolved it - I thought it was the ".com → .io"-change, but wasn't able to reproduce the issue anymore while writing this PR).
  • I'm not sure if there's a replacement for the Firefox extension or if it even still works when built manually. I removed the dead link to pre-build but kept the rest, assuming it still works.
  • I kept the http://learningwebgl.com/ link even though it is currently unavailable. It has been working until some months ago, so chances are it will return.

There are other minor things in the README I'd change, but I'm not even sure if this repository is still maintained.
If it isn't, we should update the README to refer people to alternative tools with equivalent functionality, then archive the repository.
If it is, I'll probably send some follow-ups in the future (documentation and code alike, if there's need).


(It would be nice if you can tag this PR for hacktoberfest inclusion as described in https://hacktoberfest.digitalocean.com/details#rules - feel free to ignore this last bit if you don't want this)

@ghost ghost closed this by deleting the head repository Oct 28, 2024
This pull request was closed.
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.

Directly use embed.js failed, try loading core/lib/gli.js, but gli.js isn't there?
0 participants