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

improve readme, improve .gitattributes #34

Merged
merged 2 commits into from
Jul 4, 2022

Conversation

nathanfranke
Copy link
Contributor

Fixes #33

How it looks:
image

Copy link
Contributor

@gumaciel gumaciel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change the location of this image addons/admob/assets/asset-library.png

Put out of the "assets" folder for the user not to download this image when using the plugin.

Suggestions:

  1. Create an "images" folder and add this image
  2. Consider adding on https://imgur.com/ and put the link

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@nathanfranke
Copy link
Contributor Author

All good suggestions, thanks! As for the image, I was going to put it in a separate folder but then I remembered that Godot would try to include that with the installation. See here:
image

Instead I uploaded the video directly using the README editor. Just in case that stops working, I attached another copy here. I didn't want to rely on a separate service to host the image, although it probably doesn't matter. 🙂

asset_library

@gumaciel
Copy link
Contributor

gumaciel commented Jul 4, 2022

All good suggestions, thanks! As for the image, I was going to put it in a separate folder but then I remembered that Godot would try to include that with the installation. See here: image

Yes, but I just made this change: #36

That way godot will only try to download what is actually inside the assets/ folder, which is the content of our plugin

Read more here: godotengine/godot-proposals#3648

I didn't want to add the image inside the assets/ folder because the user will download an image that won't be useful for his project


To test, you can run this command: git archive --format=zip --output project.zip HEAD

@nathanfranke
Copy link
Contributor Author

Great! I think I will try that on my own projects too!

@nathanfranke
Copy link
Contributor Author

  • Added the image to static, tested and the zip only contains addons 🎉
  • Also good news! Looks like relative paths actually do work in README! I updated the PR to utilize that.

@nathanfranke nathanfranke changed the title improve readme improve readme, improve .gitattributes Jul 4, 2022
@gumaciel gumaciel merged commit b3ef894 into poingstudios:master Jul 4, 2022
@gumaciel
Copy link
Contributor

gumaciel commented Jul 4, 2022

Thank you so much! Merged

Copy link
Contributor

@gumaciel gumaciel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@nathanfranke nathanfranke deleted the readme branch July 4, 2022 23:00
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.

Installation instructions should prefer asset library
2 participants