https://github.com/TinyPHX/Readme

Readme component for Unity, attachable to any GameObject to document what you can't in a script or the file system.
https://github.com/TinyPHX/Readme

Last synced: 4 months ago
JSON representation

Readme component for Unity, attachable to any GameObject to document what you can't in a script or the file system.

• Host: GitHub
• URL: https://github.com/TinyPHX/Readme
• Owner: TinyPHX
• License: other
• Created: 2019-06-08T16:42:42.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-22T19:49:19.000Z (over 1 year ago)
• Last Synced: 2024-02-24T08:08:54.725Z (4 months ago)
• Language: C#
• Size: 3.28 MB
• Stars: 38
• Watchers: 6
• Forks: 4
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Lists

• awesome-unity3d - Readme - Readme component for Unity, attachable to any GameObject to document what you can't in a script or the file system (Open Source Repositories / Editor)

README

        
# Readme

Readme component for Unity, attachable to any GameObject to document what you can't in a script or the file system.

## Welcome to the Readme for the Readme project!

Project is meant to allow users the ability to better document Unity GameObjects as whole. Currently, the main ways yous can include documentation in your unity project are

 * With a readme in your file system

 * With comments in your code

This leaves a gap in the documentation. What do you do when your GameObject requires some simple notes that are not related to an individual script? Or what if you just really want to make sure someone knows why you've configured a component they way you have?

Well now we have a readme for components!

### Usage Examples

#### Edit Text

![Unity Readme - Adding Text](https://i.imgur.com/9F1NVcU.gif)

#### Apply Text Styles

![Unity Readme - Applying Styles](https://imgur.com/Kg5CsCR.gif)

#### Set Colors

![Unity Readme - Applying Colors](https://imgur.com/EeOJPgK.gif)

#### Change Font Style/Size

![Unity Readme - Applying Font Style](https://imgur.com/6KJcjJu.gif)