pepperdash/PepperDashCore
1
0
Fork 0
mirror of https://github.com/PepperDash/PepperDashCore.git synced 2026-01-11 19:44:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to give Troy credit

Browse Source
This commit is contained in:
Andrew Welker
2020-09-16 15:17:29 -06:00
parent f3c814f6ec
commit 4242fe5635
1 changed files with 21 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
Readme.md
View File

@@ -3,9 +3,11 @@
## [Latest Release](https://github.com/PepperDash/PepperDashCore/releases/latest) ## [Latest Release](https://github.com/PepperDash/PepperDashCore/releases/latest)
## License ## License
Provided under MIT license Provided under MIT license
## Overview ## Overview
PepperDash Core is an open source Crestron SIMPL# library that can be used in SIMPL# Pro applications such as Essentials or as a standalone library with SIMPL+ wrappers to expose functionality in SIMPL Windows programs. PepperDash Core is an open source Crestron SIMPL# library that can be used in SIMPL# Pro applications such as Essentials or as a standalone library with SIMPL+ wrappers to expose functionality in SIMPL Windows programs.
## Constituent Elements ## Constituent Elements
@@ -13,23 +15,24 @@ PepperDash Core is an open source Crestron SIMPL# library that can be used in SI
- JSON Configuration File reading/writing - JSON Configuration File reading/writing
- PortalConfigReader - PortalConfigReader
- Generic config classes - Generic config classes
- Communications - Communications
- TCP/IP client and server - TCP/IP client and server
- Secure TCP/IP client and server - Secure TCP/IP client and server
- UDP server - UDP server
- SSH client - SSH client
- HTTP SSE client - HTTP SSE client
- HTTP (RESTful client) - HTTP (RESTful client)
- Debugging - Debugging
- Console debugging - Console debugging
- Logging both to Crestron error log as well as a custom log file - Logging both to Crestron error log as well as a custom log file
- System Info - System Info
- Reports system and Ethernet information to SIMPL via SIMPL+ - Reports system and Ethernet information to SIMPL via SIMPL+
- Device Class, IKeyed and IKeyName Interfaces - Device Class, IKeyed and IKeyName Interfaces
- Base level device class that most classes derive from - Base level device class that most classes derive from
- Password Manager - Password Manager
## Minimum Requirements ## Minimum Requirements
- PepperDash Core runs on any Crestron 3-series processor or Crestron's VC-4 platform. - PepperDash Core runs on any Crestron 3-series processor or Crestron's VC-4 platform.
- To edit and compile the source, Microsoft Visual Studio 2008 Professional with SP1 is required. - To edit and compile the source, Microsoft Visual Studio 2008 Professional with SP1 is required.
- Crestron's Simpl# Plugin is also required (must be obtained from Crestron). - Crestron's Simpl# Plugin is also required (must be obtained from Crestron).
@@ -39,12 +42,16 @@ PepperDash Core is an open source Crestron SIMPL# library that can be used in SI
None None
## Utilization ## Utilization
PepperDash Core has two main applications: PepperDash Core has two main applications:
1. As a utility library for SIMPL# Pro applications like [Essentials]([Essentials](https://github.com/PepperDash/Essentials)) 1. As a utility library for SIMPL# Pro applications like [Essentials](<[Essentials](https://github.com/PepperDash/Essentials)>)
2. As a library referenced by SIMPL+ wrapper modules in a SIMPL Windows application 2. As a library referenced by SIMPL+ wrapper modules in a SIMPL Windows application
## Documentation ## Documentation
For detailed documentation, follow this [LINK](https://github.com/PepperDash/PepperDashCore/wiki) to the Wiki.
For detailed documentation, follow this [LINK](https://github.com/PepperDash/PepperDashCore/wiki) to the Wiki.
## XSigUtility
`XSigUtility` classes included with permission of Troy Garner. See https://github.com/bitm0de/XSigUtilityLibrary for more information