search

inkle / ink-unity-integration

Unity integration for the open source ink narrative scripting language.
http://www.inklestudios.com/ink
Other
570 stars 99 forks source link

Symlinked README.md not visible in Windows #126

Closed rhys-vdw closed 4 years ago

rhys-vdw commented 4 years ago

As reported by @tomkail:

I saw you linked the readme to Assets/Plugins/Ink/README.md (which I didnt know you could do, neat!) - but there's no file at that path.

I thought this was portable to Windows, but apparently not with some configs/clients: StackOverflow discussion.

Possible fixes:

  1. Revert the PR and add a build script that copies the README into the package directory (similar to the Example.unitypackage script included in #122)
  2. Check if enabling core.symlinks in local git config resolves the issue and add a note to the README.

Given that option 2 adds friction to new contributions to the project I think it's probably simpler to just go for option 1. Sorry for the confusion @tomkail!

I'll make a fix for this.