mirror of
https://github.com/PreMiD/PreMiD.git
synced 2026-04-06 04:41:58 +02:00
wip: docs
This commit is contained in:
@@ -18,7 +18,7 @@ export default defineConfig({
|
||||
nav: [
|
||||
{
|
||||
text: "Presence Development",
|
||||
link: "/presence-development/",
|
||||
link: "/dev/getting-started",
|
||||
},
|
||||
{
|
||||
text: "Reference",
|
||||
|
||||
35
apps/docs/dev/creating-a-presence.md
Normal file
35
apps/docs/dev/creating-a-presence.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Creating a Presence
|
||||
|
||||
## Introduction
|
||||
|
||||
PreMiD Presences are the core of the PreMiD application. They allow you to add support for your favorite websites and services, or create your own custom Presences. This guide will walk you through the process of creating a Presence for PreMiD.
|
||||
|
||||
Please go through the [Getting Started](./getting-started) guide before proceeding with this guide. It will help you set up your development environment and install the necessary tools.
|
||||
|
||||
To make the process of creating a Presence easier, we have provided the `pmd` command-line interface (CLI) tool. This tool will help you generate a new Presence project with all the necessary files and configurations, so you can start coding your Presence right away.
|
||||
|
||||
The `pmd` CLI will also help you build and test your Presence before submitting it to the PreMiD Store. Testing is required to ensure your Presence works as expected and meets the quality standards. Proof that your Presence works is required for it to be approved. This is usually done by providing a video or a screenshot of your Presence in action.
|
||||
|
||||
## Creating a New Presence
|
||||
|
||||
To create a new Presence, you can use the `pmd` CLI tool. This tool will generate a new Presence project with all the necessary files and configurations. To create a new Presence, follow these steps:
|
||||
|
||||
1. Open your terminal and run the following command:
|
||||
|
||||
```sh
|
||||
pnpm exec pmd -c
|
||||
```
|
||||
|
||||
2. Follow the on-screen instructions to create a new Presence project.
|
||||
3. Start a development server to be able to build and test your Presence:
|
||||
|
||||
```sh
|
||||
pnpm exec pmd -m
|
||||
```
|
||||
|
||||
4. Open your browser and go to the PreMiD Extension settings page, then enable Developer Mode.
|
||||
5. You should now see your new Presence in the list of Presences.
|
||||
|
||||
### Coding your Presence
|
||||
|
||||
Once you have created a new Presence project, you can start coding your Presence. The `pmd` CLI tool will generate a new Presence project with all the necessary files and configurations, so you can start coding your Presence right away.
|
||||
50
apps/docs/dev/getting-started.md
Normal file
50
apps/docs/dev/getting-started.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Getting Started
|
||||
|
||||
## Installation
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Git](https://git-scm.com/).
|
||||
- [Node.js](https://nodejs.org/) version 18 or higher, includes [Corepack](https://github.com/nodejs/corepack) by default.
|
||||
- Terminal for accessing PreMiD's Developer Tools via its command-line interface (CLI).
|
||||
- Text Editor with [TypeScript](https://www.typescriptlang.org/) syntax highlighting support.
|
||||
- [Visual Studio Code](https://code.visualstudio.com/) is recommended, as it includes TypeScript support out-of-the-box.
|
||||
|
||||
### Clone the Repository
|
||||
|
||||
- Open your terminal and run the following command:
|
||||
```sh
|
||||
git clone https://github.com/PreMiD/Presences.git
|
||||
```
|
||||
- Change your working directory to the repository:
|
||||
```sh
|
||||
cd Presences
|
||||
```
|
||||
|
||||
### Install Dependencies
|
||||
|
||||
- Ensure you have Node.js installed by running:
|
||||
```sh
|
||||
node -v
|
||||
```
|
||||
If you see a version number, Node.js is installed. Make sure you have Node.js version 18 or higher.
|
||||
- Enable Corepack by running:
|
||||
```sh
|
||||
corepack enable
|
||||
```
|
||||
- Install the project dependencies:
|
||||
```sh
|
||||
pnpm install
|
||||
```
|
||||
|
||||
## Coding your Presence
|
||||
|
||||
Follow the [Creating a Presence](./creating-a-presence) guide to get started with coding your own Presence.
|
||||
|
||||
## Submitting your Presence
|
||||
|
||||
Once you've finished coding your Presence, you can submit it to the PreMiD Store for others to use. Follow the [Submitting a Presence](./submitting-a-presence) guide to learn how to submit your Presence.
|
||||
|
||||
A member of the PreMiD Team will review your submission and if it meets the guidelines, it will be added to the PreMiD Store for everyone to use. If your submission is rejected, you will receive feedback on how to improve it.
|
||||
|
||||
Please note that all submissions are subject to review and approval by the PreMiD Team. We reserve the right to reject any submission that does not meet our guidelines or quality standards. Reviews may take up to 7 days to complete.
|
||||
0
apps/docs/dev/submitting-a-presence.md
Normal file
0
apps/docs/dev/submitting-a-presence.md
Normal file
@@ -15,7 +15,7 @@ hero:
|
||||
link: /getting-started
|
||||
- theme: alt
|
||||
text: Presence Development
|
||||
link: /presence-development
|
||||
link: /dev/getting-started
|
||||
features:
|
||||
- icon: 🛠️
|
||||
title: Extensible
|
||||
|
||||
Reference in New Issue
Block a user