Skip to content

Commit

Permalink
Initial Project Setup
Browse files Browse the repository at this point in the history
  • Loading branch information
StephenHodgson committed May 29, 2022
1 parent ceaff28 commit 8e3589b
Show file tree
Hide file tree
Showing 57 changed files with 447 additions and 291 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
github: StephenHodgson
github: ProjectAuthor
github: StephenHodgson
131 changes: 0 additions & 131 deletions InitializeTemplate.ps1

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) #CURRENT_YEAR# ProjectAuthor
Copyright (c) 2022 StephenHodgson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down

This file was deleted.

This file was deleted.

2 changes: 0 additions & 2 deletions ProjectScope.ProjectName/ProjectSettings/ProjectVersion.txt

This file was deleted.

37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,34 @@
# upm-template
# com.utilities.rest

A Unity package manager repository template for quickly creating and setting up new UPM package projects in Unity.
[![openupm](https://img.shields.io/npm/v/com.utilities.rest?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.utilities.rest/)

A Utilities.Rest package for the [Unity](https://unity.com/) Game Engine.

## Installing

### Via Unity Package Manager and OpenUPM

- Open your Unity project settings
- Select the `Package Manager`
![scoped-registries](Documentation~/images/package-manager-scopes.png)
- Add the OpenUPM package registry:
- `Name: OpenUPM`
- `URL: https://package.openupm.com`
- `Scope(s):`
- `com.utilities.rest`
- Open the Unity Package Manager window
- Change the Registry from Unity to `My Registries`
- Add the `Utilities.Rest` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager
- Add package from git url: `https://github.com/StephenHodgson/com.utilities.rest.git#upm`

## Getting Started

1. Create a new repository in GitHub using this template
2. Clone to your local machine
3. Run the `InitializeTemplate.ps1` script from powershell, a command line, or terminal
4. ???
5. Profit
### Project Setup

```csharp
// TODO
```
File renamed without changes.
File renamed without changes.
7 changes: 7 additions & 0 deletions Utilities.Rest/Assets/csc.rsp.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/CHANGELOG.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/Editor.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ProjectScope.ProjectName.Editor",
"name": "Utilities.Rest.Editor",
"references": [],
"includePlatforms": [
"Editor"
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) #CURRENT_YEAR# ProjectAuthor
Copyright (c) 2022 StephenHodgson

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
7 changes: 7 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/LICENSE.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# com.projectscope.projectname
# com.utilities.rest

[![openupm](https://img.shields.io/npm/v/com.projectscope.projectname?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.projectscope.projectname/)
[![openupm](https://img.shields.io/npm/v/com.utilities.rest?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.utilities.rest/)

A ProjectScope.ProjectName package for the [Unity](https://unity.com/) Game Engine.
A Utilities.Rest package for the [Unity](https://unity.com/) Game Engine.

## Installing

Expand All @@ -15,15 +15,15 @@ A ProjectScope.ProjectName package for the [Unity](https://unity.com/) Game Engi
- `Name: OpenUPM`
- `URL: https://package.openupm.com`
- `Scope(s):`
- `com.projectscope.projectname`
- `com.utilities.rest`
- Open the Unity Package Manager window
- Change the Registry from Unity to `My Registries`
- Add the `ProjectScope.ProjectName` package
- Add the `Utilities.Rest` package

### Via Unity Package Manager and Git url

- Open your Unity Package Manager
- Add package from git url: `https://github.com/ProjectAuthor/com.projectscope.projectname.git#upm`
- Add package from git url: `https://github.com/StephenHodgson/com.utilities.rest.git#upm`

## Getting Started

Expand Down
7 changes: 7 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/Runtime.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"name": "Utilities.Rest"
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions Utilities.Rest/Packages/com.utilities.rest/Tests.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// Licensed under the MIT License. See LICENSE in the project root for license information.
// Licensed under the MIT License. See LICENSE in the project root for license information.

using NUnit.Framework;

namespace ProjectScope.ProjectName.Tests
namespace Utilities.Rest.Tests
{
internal class ExampleTestScript
{
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ProjectScope.ProjectName.Tests",
"name": "Utilities.Rest.Tests",
"references": [
"GUID:27619889b8ba8c24980f49ee34dbb44a",
"GUID:0acc523941302664db1f4e527237feb3"
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 8e3589b

Please sign in to comment.