Skip to content
This repository has been archived by the owner on Jan 14, 2025. It is now read-only.

Commit

Permalink
Moved demo content out of package
Browse files Browse the repository at this point in the history
* Fixed issue of warnings showing up for package due to demo content being present in package and not in an AsmDef
* Fixed casing of readme at root of repo and included updated readme and changelog in package contents
* Bumped version locally to 0.1.3
  • Loading branch information
jzapdot committed Dec 4, 2022
1 parent 1fffe9e commit 6d5d6bf
Show file tree
Hide file tree
Showing 20 changed files with 108 additions and 4 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Releases]
### [0.1.3] - 2022-12-04
#### Fixed
* Moved demo content out of package folder.

### [0.1.2] - 2022-12-03
#### Fixed
* Added missing dependency for NaughtyAttributes

### [0.1.1] - 2022-12-02
#### Fixed
* Fixed incorrect min unity version for package, replaced 2022.3.14f1 with 2021.3.14f1

### [0.1.0] - 2022-12-03
#### Added
* Created initial project using library template
Expand Down
File renamed without changes.
File renamed without changes.
45 changes: 45 additions & 0 deletions Unity/Assets/JCMG/Slate/CHANGELOG.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Releases]
### [0.1.3] - 2022-12-04
#### Fixed
* Moved demo content out of package folder.

### [0.1.2] - 2022-12-03
#### Fixed
* Added missing dependency for NaughtyAttributes

### [0.1.1] - 2022-12-02
#### Fixed
* Fixed incorrect min unity version for package, replaced 2022.3.14f1 with 2021.3.14f1

### [0.1.0] - 2022-12-03
#### Added
* Created initial project using library template
* Added initial library content and example demo scene.

## CL Template
This template should be used for any new releases to document any changes.

### [0.0.0] - 1900-01-01
#### Added
For new features.

#### Changed
For changes in existing functionality.

#### Deprecated
For soon-to-be removed features.

#### Removed
for now removed features.

#### Fixed
For any bug fixes.

#### Security
In case of vulnerabilities.
47 changes: 47 additions & 0 deletions Unity/Assets/JCMG/Slate/README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
[![Continous Deployment](https://github.com/jeffcampbellmakesgames/jcmg-slate/actions/workflows/publish_release.yml/badge.svg)](https://github.com/jeffcampbellmakesgames/jcmg-slate/actions/workflows/publish_release.yml)
[![openupm](https://img.shields.io/npm/v/com.jeffcampbellmakesgames.slate?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.jeffcampbellmakesgames.slate/)
![GitHub issues](https://img.shields.io/github/issues/jeffcampbellmakesgames/jcmg-slate)
[![Twitter Follow](https://img.shields.io/badge/twitter-%40stampyturtle-blue.svg?style=flat&label=Follow)](https://twitter.com/stampyturtle)

# JCMG Slate
## About
JCMG Slate is a lightweight UI framework library for Unity. It contains a simple paradigm for defining distinct UIScreens and offers an easy way to look them up and hook up animations for them.

## Minimum Requirements
* **Unity Version:** 2021.3.X or Higher
* **Scripting Runtime**: .Net 4.X

## Installing JCMG Slate
Using this library in your project can be done in three ways:

### Install via OpenUPM
The package is available on the [openupm registry](https://openupm.com/). It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).

```
openupm add com.jeffcampbellmakesgames.jcmg-slate
```

### Install via GIT URL
Using the native Unity Package Manager introduced in 2017.2, you can add this library as a package by modifying your `manifest.json` file found at `/ProjectName/Packages/manifest.json` to include it as a dependency. See the example below on how to reference it.

```
{
"dependencies": {
...
"com.jeffcampbellmakesgames.jcmg-slate" : "https://github.com/jeffcampbellmakesgames/jcmg-slate.git#release/stable",
...
}
}
```


You will need to have Git installed and available in your system's PATH.

## Support
If this is useful to you and/or you’d like to see future development and more tools in the future, please consider supporting it either by contributing to the Github projects (submitting bug reports or features and/or creating pull requests) or by buying me coffee using any of the links below. Every little bit helps!

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I3I2W7GX)

## Contributing

For information on how to contribute and code style guidelines, please visit [here](CONTRIBUTING.md).
8 changes: 4 additions & 4 deletions Unity/Assets/JCMG/Slate/Scripts/Editor/VersionConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public static class VersionConstants
/// <summary>
/// The semantic version
/// </summary>
public const string VERSION = "0.1.2";
public const string VERSION = "0.1.3";

/// <summary>
/// The branch of GIT this package was published from.
Expand All @@ -26,16 +26,16 @@ public static class VersionConstants
/// <summary>
/// The current GIT commit hash this package was published on.
/// </summary>
public const string GIT_COMMIT = "0642e3138625fbba87b81f71b2e6fa463881ef93";
public const string GIT_COMMIT = "1fffe9eb292c5cf0523ad77eeba5cf0c7b68894e";

/// <summary>
/// The UTC human-readable date this package was published at.
/// </summary>
public const string PUBLISH_DATE = "Saturday, December 3, 2022";
public const string PUBLISH_DATE = "Sunday, December 4, 2022";

/// <summary>
/// The UTC time this package was published at.
/// </summary>
public const string PUBLISH_TIME = "12/03/2022 21:55:33";
public const string PUBLISH_TIME = "12/04/2022 18:15:51";
}
}

0 comments on commit 6d5d6bf

Please sign in to comment.