Add LTS Instructions, and Recommended Install Instruction to Readme #475
Closed
Katerlad
started this conversation in
Documentation
Replies: 2 comments
-
I feel like ParrelSync is a great example of a Git readme that is clear, and targeted for new users. |
Beta Was this translation helpful? Give feedback.
0 replies
-
Much of these steps do not apply anymore. The versioning explanation could be useful, and explaining that Pro/Free can be installed over each other. Putting this under documentation on the road map. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Just a suggestion to Add the LTS methodology explanation and recommended install instructions for first time install as well as ReImporting Fishnet.
I know there will be an argument that you want as little places to update info as possible, so you may add this in the Docs instead, but keep in mind for new users its intuitive to get Install and version info from the place you are downloading, and then learn how to use the product via docs.
This would be on the ReadMe/ front page of Github as well as probably the Asset Store, These Instructions should probably be in the Text that is shown in the Package manager as well?
Something maybe like this?
How to Download Latest
Fishnet uses the Semantic Versioning mixed with identifiers that detail these things detailed below.
X.Y.Z(R)
X <= Major Version, Y <= Minor Version, Z <= Hotfixes, (R) <= Released Branch
Unless you want to test pre-released versions, Make sure you are downloading the most up to date Released branch!
Recommended Install Instructions
First Time Install
Free Version
Import the package by adding Fishnet to your assets in the Unity Asset Store, or by downloading the package here in this git repo.
Pro Version
If you are a subscriber to FirstGearGames on Patreon or Github, you can download the Pro Versions at www.firstgeargames.com
Upgrading Versions
Release Mode
Info about release mode here.
Does it start in release mode?
Are you out of release mode as soon as you turn on a experimental feature?
Beta Was this translation helpful? Give feedback.
All reactions