- Enhancement: Updating
package.json
version number to1.0.0-pre.1
, per latest Unity standard. - Enhancement: Updating documentation to the latest folder structure and content specs, such as linking to the
Samples~
section in the Unity's documentation instead of saying, "as of this writing, there is no official documentation" (when there obviously is, now.) - Bug Fix: forgot to ignore
Documentation~/index.md
.
- Enhancement: restructuring the documentation so that the
README.md
at the root of the project becomes the homepage of the DocFX-generated documentation. The oldindex.md
has now been added toDocumentation~/manual
folder, as the first page describing the content of this package. This should make updating documentation easier for future projects, as only theREADME.md
file needs to be updated to change the homepage. - Enhancement: extending license year to 2022
- Enhancement: adding conditionals to
.github/workflows/documentation.yml
and.github/workflows/mirror.yml
to prevent the jobs from running on other repos copying this template automatically. Added comments, and updated documentation indicating these conditional's purpose, and how to remove them.
- Enhancement: changing the mirror action to this one.
- Feature: added Github Action to mirror the repository to
Bitbucket
automatically. This new file is available here:.github/workflows/mirror.yml
. - Enhancement: updated Customize Package manual talking about what files from
.github
can be deleted or edited.
- Typo: Fixed the documentation build status badge in
README.md
.
- Feature: added Github Action to auto-generate documentation in the
Documentation~
folder using DocFX for Unity project as reference. - Feature: adding Github feature, sponsorship! The
FUNDING.yml
file in.github
folder adds a sponsorship button on Github with a link to Ko-Fi. - Enhancement: Updated
README.md
to link to the newly-generated documentation, and provide better installation instructions.
- Enhancement: making the platform
OmiyaGames.Template.Editor.asmdef
andOmiyaGames.Template.Editor.Tests.asmdef
supports to only the editor.
- Rename:
EditorExampleTest.cs
toTestEditorExample.cs
. Updated class name along with it. - Rename:
RuntimeExampleTest.cs
toTestRuntimeExample.cs
. Updated class name along with it. - Typo: Removed
[CustomEditor(typeof(RuntimeExample))]
attribute fromEditorExampleTest.cs
. It serves no purpose. - Typo: Removed
[CustomEditor(typeof(RuntimeExample))]
attribute fromEditorExampleTest.cs
. It serves no purpose.
- Feature: Updated the
Tests
assembly definition files and example scripts with proper configuration for editing/creating new unit test scripts. Also updatedpackage.json
with NUnit as a required dependency. - Enhancement: Added significantly more information in
README.md
so other people can use a more fleshed-out markdown format to start their documentation. - Enhancement: Changing
package.json
into a type -> Tool, and added one more keyword. - Enhancement: Noting
THIRD PARTY NOTICES.md
is just an example, and this project doesn't actually use any 3rd party tools yet (besides unit testing, but I think that's already implied).
- Feature: adding a
Documentation~/Doxyfile
to make generating Doxygen files a little easier.
- Typo: renaming
Documentation~/index.md
toDocumentation~/Template.md
to match Unity recommendation.
- Bug fix:
Editor/EditorExample.cs
now compiles properly. - Typo: updated namespace in
Tests/Editor/EditorExampleTest.cs
to inlucdeTest
. - Typo: changing the
THIRD PARTY NOTICES.md
Credits section to use a list, so each field is in its own line.
- Initial release:
- Confirmed the template project works by battle-testing it to Omiya Games - Common package.
- Updated every text to be more generic.