Add 'Custom ReadMe' to Unity Inspector Window for FTUE

[SamuelAsherRivello]

Background Info

Projects

• Tezos SDK For Unity - Examples - A set of scene by scene examples showcasing SDK Features in isolation
• Tezos SDK For Unity - Sample {tbd} Game - A complete game showcasing SDK Features together

Both projects will include a custom implementation of ReadMe within Unity.

ToDo

I suggest that the Tezos SDK itself also have this functionality. It provides good FTUE orientation and provides consistency with the projects above.

If the team agrees, please complete this ticket. Here are steps to complete and further below are some helpful demo resources.

1. Copy Demo code from the Demo Project to the /Assets/ folder of the SDK Repo 1 Validate the ReadMe works as shown in the video
2. Move Demo code to the /Package/ of the repo (subfolder of your choice)
3. Validate the ReadMe works (still) as shown in the video
4. Update the ReadMe layout (video explains how) to meet your final specs

Dependencies

While not strictly required, I recommend to complete the following before starting this ticket.

• https://github.com/trilitech/tezos-unity-sdk/issues/10
• https://github.com/trilitech/tezos-unity-sdk/issues/11

Demo

Demo Resources

• Demo Project - https://github.com/trilitech/internal-unity-readme-demo
• Demo Video - (Tezos Slack Video Link) - The video ends abruptly :) , but it provides the complete info

Demo Screenshot

[SamuelAsherRivello]

Great feedback on https://tezos-dev.slack.com/archives/C04JEV96Q2H/p1682035019596739

Here is a suggested workflow to use the RMC Readme without any UPM dependency on RMC libraries.

Steps

1. Open the https://github.com/trilitech/internal-unity-readme-demo

   • Update the contents of the readme.asset to the desired text layout. Do this only if needed (it may be good as is). Once happy with it, move to the next step
   • Ensure the readme.asset displays automatically when the project first opens, that the readme.asset renders properly in the inspector window, and that the Unity top menu functions properly to pen the Readme.asset. This is existing, expected behavior.

2. Copy the readme.asset and source files to the Tezos SDK package. Thus no dependency on any RMC-library is needed.

   • Ensure (again, now in the package) the readme.asset displays automatically when the project first opens, that the readme.asset renders properly in the inspector window, and that the Unity top menu functions properly to pen the Readme.asset. This is existing, expected behavior.

3. Create a new unity project. Import the Tezos SDK package.

   • Ensure (again, now in the new project) the readme.asset displays automatically when the project first opens, that the readme.asset renders properly in the inspector window, and that the Unity top menu functions properly to pen the Readme.asset. This is existing, expected behavior.