-
Notifications
You must be signed in to change notification settings - Fork 234
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3eb3244
commit 40a8682
Showing
2 changed files
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Style-Guide | ||
|
||
**`Notice: this guide is still in development!`** | ||
|
||
This document is there to outline the development principles, style and quality of code. The goal of this guide is to homogenies the codebase. This guide will not be enforced to the letter but rather to it's spirit. | ||
|
||
## Project Goals | ||
|
||
The main goal of the project is to provide an intuitive [Software Development Kit (SDK)](https://www.ibm.com/cloud/blog/sdk-vs-api) for the [Proxmox Virtual Environment (PVE)](https://www.proxmox.com/en/proxmox-ve). | ||
|
||
The secondary goal of the project is to provide a [Command Line Interface (CLI)](https://en.wikipedia.org/wiki/Command-line_interface) to interact with the PVE. A goal of this CLI is provide implementation examples of this SDK. | ||
|
||
### Command Line Interface | ||
|
||
More information about the CLI van be found is [cli.md](cli.md) | ||
|
||
### Software Development Kit | ||
|
||
More information about the SDK van be found is [sdk.md](sdk.md) |