{"id":22963162,"url":"https://github.com/samuelasherrivello/rmc-readme-authoring","last_synced_at":"2026-05-05T07:32:21.347Z","repository":{"id":66929243,"uuid":"604144325","full_name":"SamuelAsherRivello/rmc-readme-authoring","owner":"SamuelAsherRivello","description":"Add custom readme to Unity Inspector Window","archived":false,"fork":false,"pushed_at":"2023-09-13T17:58:06.000Z","size":262,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T03:43:14.054Z","etag":null,"topics":["unity","unity3d"],"latest_commit_sha":null,"homepage":"http://SamuelAsherRivello.com","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SamuelAsherRivello.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-20T12:33:13.000Z","updated_at":"2023-03-23T10:02:32.000Z","dependencies_parsed_at":"2025-04-02T03:50:53.951Z","dependency_job_id":null,"html_url":"https://github.com/SamuelAsherRivello/rmc-readme-authoring","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/SamuelAsherRivello/rmc-readme-authoring","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamuelAsherRivello%2Frmc-readme-authoring","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamuelAsherRivello%2Frmc-readme-authoring/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamuelAsherRivello%2Frmc-readme-authoring/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamuelAsherRivello%2Frmc-readme-authoring/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SamuelAsherRivello","download_url":"https://codeload.github.com/SamuelAsherRivello/rmc-readme-authoring/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamuelAsherRivello%2Frmc-readme-authoring/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32640533,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"online","status_checked_at":"2026-05-05T02:00:06.033Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["unity","unity3d"],"created_at":"2024-12-14T19:21:01.095Z","updated_at":"2026-05-05T07:32:21.341Z","avatar_url":"https://github.com/SamuelAsherRivello.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm package](https://img.shields.io/npm/v/com.rmc.rmc-readme-authoring)](https://www.npmjs.com/package/com.rmc.rmc-readme-authoring)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\n\n\u003cimg width = \"400\" src=\"https://raw.githubusercontent.com/SamuelAsherRivello/rmc-core/main/RMC%20Core/Documentation~/com.rmc_namespace_logo.png\" /\u003e\n\n# RMC Readme Authoring\n\n- [How To Use](#how-to-use)\n- [Install](#install)\n  - [Via NPM](#via-npm)\n  - [Via Git URL](#via-git-url)\n  - [Tests](#tests)\n  - [Samples](#samples)\n- [Configuration](#configuration)\n\n\u003c!-- toc --\u003e\n\n## How to use\n\nThis is a custom library to **author** a custom ReadMe for the Unity Inspector Window.\n\nIf you only want to **display** a custom ReadMe, see the https://github.com/SamuelAsherRivello/rmc-readme-authoring.\n\n## Example Image\n\nHere is the Unity editor with the RMC ReadMe displayed in the Inspector Window.\n\n\u003cimg width = \"400\" src=\"https://raw.githubusercontent.com/SamuelAsherRivello/rmc-readme-authoring/main/ReadMe Authoring/Documentation/Images/Screenshot.png\"\u003e\n## Install\n\n### Via NPM\n\nYou can either use the Unity Package Manager Window (UPM) or directly edit the manifest file. The result will be the same.\n\n**UPM**\n\nTo use the [Package Manager Window](https://docs.unity3d.com/Manual/upm-ui.html), first add a [Scoped Registry](https://docs.unity3d.com/2023.1/Documentation/Manual/upm-scoped.html), then click on the interface menu ( `Status Bar → (+) Icon → Add Package By Name ...` ).\n\n**Manifest File**\n\nOr to edit the `Packages/manifest.json` directly with your favorite text editor, add a scoped registry then the following line(s) to dependencies block:\n\n```json\n{\n  \"scopedRegistries\": [\n    {\n      \"name\": \"npmjs\",\n      \"url\": \"https://registry.npmjs.org/\",\n      \"scopes\": [\n        \"com.rmc\"\n      ]\n    }\n  ],\n  \"dependencies\": {\n    \"com.rmc.rmc-readme-authoring\": \"1.1.9\",\n    \"com.rmc.rmc-readme\": \"1.2.1\"\n  }\n}\n```\nPackage should now appear in package manager.\n\n\n### Via Git URL\n\nYou can either use the Unity Package Manager (UPM) Window or directly edit the manifest file. The result will be the same.\n\n**UPM**\n\nTo use the [Package Manager Window](https://docs.unity3d.com/Manual/upm-ui.html) click on the interface menu ( `Status Bar → (+) Icon → Add Package From Git Url ...` ).\n\n**Manifest File**\n\nOr to edit the `Packages/manifest.json` directly with your favorite text editor, add following line(s) to the dependencies block:\n```json\n{\n  \"dependencies\": {\n      \"com.rmc.rmc-readme-authoring\": \"https://github.com/SamuelAsherRivello/rmc-readme-authoring.git\",\n      \"com.rmc.rmc-readme\": \"https://github.com/SamuelAsherRivello/rmc-readme.git\"\n  }\n}\n```\n\n### Tests\n\nThe package can optionally be set as *testable*.\nIn practice this means that tests in the package will be visible in the [Unity Test Runner](https://docs.unity3d.com/2017.4/Documentation/Manual/testing-editortestsrunner.html).\n\nOpen `Packages/manifest.json` with your favorite text editor. Add following line **after** the dependencies block:\n```json\n{\n  \"dependencies\": {\n  },\n  \"testables\": [ \"com.rmc.rmc-readme-authoring\" ]\n}\n```\n\n### Samples\n\nSome packages include optional samples with clear use cases. To import and run the samples:\n\n1. Open Unity \n1. Complete the package installation (See above)\n1. Open the [Package Manager Window](https://docs.unity3d.com/Manual/upm-ui.html)\n1. Select this package \n1. Select samples\n1. Import\n\n## Configuration\n\n* `Unity Target` - [Standalone MAC/PC](https://support.unity.com/hc/en-us/articles/206336795-What-platforms-are-supported-by-Unity-)\n* `Unity Version` - Any [Unity Editor](https://unity.com/download) 2021.x or higher\n* `Unity Rendering` - Any [Unity Render Pipeline](https://docs.unity3d.com/Manual/universal-render-pipeline.html)\n* `Unity Aspect Ratio` - Any [Unity Game View](https://docs.unity3d.com/Manual/GameView.html)\n\n\nCreated By\n=============\n\n- Samuel Asher Rivello \n- Over 23 years XP with game development (2023)\n- Over 10 years XP with Unity (2023)\n\nContact\n=============\n\n- Twitter - \u003ca href=\"https://twitter.com/srivello/\"\u003e@srivello\u003c/a\u003e\n- Resume \u0026 Portfolio - \u003ca href=\"http://www.SamuelAsherRivello.com\"\u003eSamuelAsherRivello.com\u003c/a\u003e\n- Source Code on Git - \u003ca href=\"https://github.com/SamuelAsherRivello/\"\u003eGithub.com/SamuelAsherRivello\u003c/a\u003e\n- LinkedIn - \u003ca href=\"https://Linkedin.com/in/SamuelAsherRivello\"\u003eLinkedin.com/in/SamuelAsherRivello\u003c/a\u003e \u003c--- Say Hello! :)\n\nLicense\n=============\n\nProvided as-is under MIT License | Copyright © 2023 Rivello Multimedia Consulting, LLC\n\n\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamuelasherrivello%2Frmc-readme-authoring","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamuelasherrivello%2Frmc-readme-authoring","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamuelasherrivello%2Frmc-readme-authoring/lists"}