Skip to content

Commit

Permalink
Update PRG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
scottgriv committed Nov 20, 2023
1 parent bd294ea commit 31b5fe2
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions PRG.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,44 @@
# Personal Repisitory Guidelines (PRG) Connection File
<div align="center">
<a href="https://github.com/scottgriv/PRG-Personal-Repository-Guidelines" target="_blank">
<img src="https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/raw/main/docs/images/PRG.png" width="200" height="200"/>
</a>
</div>

This repository is catagorized under the **PRG** system.
<h1 align="center">Personal Repository Guidelines (PRG) Connection File</h1>

This file is used to connect this repository to the **PRG** project categorization system.

---------------

## Project Information

Repository Tier: Gold <br>
Technology: iOS, watchOS, UIKit, Objective-C, Swift, PHP, MySQL <br>
Category: Mobile Application <br>
Order: 3 <br>
**Repository Tier:** Gold <br>
**Technology:** iOS, watchOS, UIKit, Objective-C, Swift, PHP, MySQL <br>
**Category:** Mobile Application <br>
**Order:** 3 <br>

## How this works
## Parameters

This file connects this repository to the **PRG** guideline and categorization system.
- **Repository Tier (Required):** Gold, Silver, Bronze, or Optimized (required for PRG - if you don't add a tier it will be displayed as "Optimized" by default)
- **Technologies (Optional):** List the technologies used to build your project here (e.g. Markdown, API, GitHub Actions, Jekyll, Python, DataTables, etc.)
- **Category (Optional):** List categories for your project here (e.g. Web, Mobile, API, etc.)
- **Order (Optional):** By default, repos are ranked by Tier, then Create Date, but you can also add an integer (e.g. 1, 2, 12, etc.) to sort in between Tier and Create Date

> [!NOTE]
> Include this file in your projects root folder for this repo to properly connect to your PRG system.
> Lines 5-8 are mapped in the `scripts/project_tier_table.py` script to the PRG system. Do not move or change these lines.
> Private repositories will not be included in the PRG system. To include a private repository or an external project outside of GitHub, add them to the `categories/project_tier_table_private.md` table manually following the repos that are already in there as a template.
## How this works

## Parameters
This file connects this repository to the **PRG** guideline and categorization system.
- Include this file in your projects root folder for this repo to properly connect to your PRG system.
- To include private repos (if configured to ignore private repos in the script) or an external project outside of GitHub, add them to the `categories/project_tier_table_private.md` table manually following the structure of the table.

- **Repository Tier (Required):** Gold, Silver, or Bronze (required for PRG)
- **Technologies (Optional):** List the technologies used to build your project here (optional)
- **Category (Optional):** List categories for your project here (optional)
- **Order (Optional):** By default, repos are ranked by Tier, then Create Date, but you can also add an integer (1, 2, 12, etc.) to sort in between Tier and Create Date (optional)
> [!CAUTION]
> Lines 7-10 are mapped in the `scripts/project_tier_table.py` script to the PRG system. Do not move or change these lines without adjusting the script to account for this change.
## Visit the PRG Repository

Visit the official [Personal Repository Guidelines (PRG)](https://github.com/scottgriv/PRG-Personal-Repository-Guidelines) repository for more details.

<p align="center">
<a href="https://github.com/scottgriv/PRG-Personal-Repository-Guidelines" target="_blank">
<img src="https://github.com/scottgriv/PRG-Personal-Repository-Guidelines/raw/main/docs/images/prg_optimized.png" alt="Optimized" width="138" height="51" />
</a>
</p>

0 comments on commit 31b5fe2

Please sign in to comment.