Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(dev-docs): Update dev docs 📝 #2

Merged
merged 2 commits into from
Jul 19, 2021
Merged

feat(dev-docs): Update dev docs 📝 #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e479376
feat(docs): Add basic contributing docs 📝
bengreenier Jul 19, 2021
bbfb0d4
fix(third-party): Add mono/t4 notice ⚠
bengreenier Jul 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Documentation~/manual/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Contributing

To contribute to `faster-games/t4` here are some things you'll want to know:

+ `Documentation~\scripts\update-engine.ps1` can be used to pull `mono/t4` updates
+ `Documentation~\scripts\generate-docs.ps1` can be used to re-generate `docfx` docs
+ Min-supported Unity version is documented in `package.json`
+ `.gitattributes` should force `LF` endings

Other than that, we use a normal fork and PR process to contribute! Feel free to send a PR, or open an Issue to discuss approaches.
2 changes: 2 additions & 0 deletions Documentation~/manual/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
- name: Getting Started
href: getting-started.md
- name: Contributing
href: contributing.md
29 changes: 29 additions & 0 deletions Documentation~/scripts/update-engine.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
param (
[string]
$Version = "2.2.1"
)

$WorkingDirectory="dist/.t4"
$LibDirectory="Editor/TextTemplating"

try {
Remove-Item -Recurse -Force "$WorkingDirectory"
} catch {}

if (!(Test-Path $WorkingDirectory))
{
[System.IO.Directory]::CreateDirectory($WorkingDirectory)
}


Invoke-WebRequest -Uri "https://github.com/mono/t4/archive/refs/tags/v$Version.zip" -OutFile "$WorkingDirectory/lib.zip"
Expand-Archive -Path "$WorkingDirectory/lib.zip" -DestinationPath "$WorkingDirectory/lib/"
Copy-Item -Recurse -Path "$WorkingDirectory/lib/t4-$Version/Mono.TextTemplating/" -Destination "$WorkingDirectory/TextTemplating/"
Remove-Item -Recurse -Force "$WorkingDirectory/lib"
Remove-Item -Force "$WorkingDirectory/TextTemplating/Mono.TextTemplating.csproj"
Remove-Item -Force "$WorkingDirectory/TextTemplating/AssemblyInfo.cs"
Remove-Item -Force "$WorkingDirectory/lib.zip"
try {
Remove-Item -Recurse -Force "$LibDirectory/"
} catch {}
Copy-Item -Recurse -Path "$WorkingDirectory/TextTemplating/" -Destination "$LibDirectory/"
3 changes: 3 additions & 0 deletions Third Party Notices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# mono/t4

This library uses [mono/t4](https://github.com/mono/t4) to provide T4 template generation. This is only possible due to the great work done by those folks. Thank you!