Skip to content

Commit

Permalink
Remove template doc info
Browse files Browse the repository at this point in the history
  • Loading branch information
RobProductions authored Mar 16, 2023
1 parent 5ee40bb commit b48c07c
Showing 1 changed file with 2 additions and 20 deletions.
22 changes: 2 additions & 20 deletions Documentation~/OpenEOSDocumentation.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,11 @@
# Overview

## OpenGraphGUI

An open source custom Shader GUI for Unity.

## Usage

Most up to date info can be found in the README.md file.

## Installation

1. Open the Package Manager in Unity
2. Click the '+' icon and hit *"Add package from git URL"*
3. Add the GitHub URL of OpenGraphGUI: [https://github.com/RobProductions/OpenGraphGUI](https://github.com/RobProductions/OpenGraphGUI)
4. Wait for download to complete
5. Add the custom GUI class *RPOpenGraphGUI* to the *Custom Editor GUI* field in your ShaderGraph of choice

If installation fails due to version requirements, you may be able force OpenGraphGUI to work by downloading the project as .zip and editing the "package.json" file to lower the Unity requirement. Deleting the .meta files may also be necessary and shouldn't break anything... I think. Then use the *"Add package from disk"* option to add your custom version instead.

If you're looking to add a specific release of OpenGraphGUI, you can specify a release tag with the hashtag like so: "https://github.com/RobProductions/OpenGraphGUI#ReleaseNumber"
Most up to date usage info and installation instructions can be found in the README.md file in the package root.

## Contributors

Created by [RobProductions](https://twitter.com/RobProductions). RobProductions' Steam games can be found [here](https://store.steampowered.com/developer/robproductions).

## License

This package is licensed under the MIT License, Copyright (c) 2022 RobProductions. You are free to use, copy, and modify as described in the included LICENSE.md file. This License was selected because it is the closest to "Open Source" that I could find commonly used for software. The software is provided "as is", without warranty of any kind.
The license information can be found in the README.md and the LICENSE.md file in the package root.

0 comments on commit b48c07c

Please sign in to comment.