mirror of
https://github.com/meisnate12/Plex-Meta-Manager
synced 2024-11-10 06:54:21 +00:00
[8] update README
This commit is contained in:
meisnate12
parent
f9f683fc1d
commit
a7bf1e54ff
4 changed files with 38 additions and 4 deletions
21
.github/workflows/commit.yml
vendored
Normal file
21
.github/workflows/commit.yml
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
name: Commit Notification
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ develop ]
|
||||
|
||||
jobs:
|
||||
|
||||
release:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
|
||||
- name: Send Discord Release Notification
|
||||
uses: meisnate12/discord-notifications@master
|
||||
with:
|
||||
webhook_id: ${{ secrets.BUILD_WEBHOOK_ID }}
|
||||
webhook_token: ${{ secrets.BUILD_WEBHOOK_TOKEN }}
|
||||
title: Plex Meta Manager Develop Commit
|
||||
username: PMM Develop
|
||||
avatar_url: https://raw.githubusercontent.com/meisnate12/Plex-Meta-Manager/master/.github/pmm.png
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly)
|
||||
|
||||
[](https://discord.gg/NfH6mGFuAB)
|
||||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
|
|
@ -35,14 +35,20 @@ If you find steps 1-3 above daunting, there are some walkthroughs available that
|
|||
|
||||
### Development
|
||||
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
|
||||
|
||||
The [develop](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) branch has the most updated **documented** fixes and enhancements to Plex Meta Manager. This version is tested and documented to some degree, but it is still an active development branch, so there may be rough edges.
|
||||
|
||||
If switching to the develop build, it is recommended to also use the [develop](https://metamanager.wiki/en/develop/) branch of the wiki, which documents any changes made from the Master build.
|
||||
|
||||
### Nightly
|
||||
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly)
|
||||
|
||||
There is also a [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) build which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented.
|
||||
|
||||
**This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.**
|
||||
|
||||
As this build is subject to extreme change, there is no promise of the feature being documented in the [nightly](https://metamanager.wiki/en/nightly/) branch of the wiki and all discussions relating to changes made in the nightly build will be held within the [Plex Meta Manager Discord Server](https://discord.gg/NfH6mGFuAB).
|
||||
|
||||
## Example Usage
|
||||
|
|
|
|||
2
VERSION
2
VERSION
|
|
@ -1 +1 @@
|
|||
1.16.2-develop7
|
||||
1.16.2-develop8
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@
|
|||
[](https://github.com/meisnate12/Plex-Meta-Manager/releases)
|
||||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly)
|
||||
|
||||
[](https://discord.gg/NfH6mGFuAB)
|
||||
[](https://hub.docker.com/r/meisnate12/plex-meta-manager)
|
||||
|
|
@ -14,7 +15,7 @@ Plex Meta Manager is an open source Python 3 project that has been designed to e
|
|||
|
||||
## Getting Started
|
||||
|
||||
1. Install Plex Meta Manager; this process is described [here](/home/installation).
|
||||
1. Install Plex Meta Manager; this process is described [here](home/installation).
|
||||
|
||||
2. Once installed, you have to create a [Configuration File](config/configuration), which contains URLs and credentials and the like which are used to connect to services like Plex and TMDB.
|
||||
|
||||
|
|
@ -34,6 +35,8 @@ If you find steps 1-3 above daunting, there are some walkthroughs available that
|
|||
|
||||
### Development
|
||||
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop)
|
||||
|
||||
The [develop](https://github.com/meisnate12/Plex-Meta-Manager/tree/develop) branch has the most updated **documented** fixes and enhancements to Plex Meta Manager. This version is tested and documented to some degree, but it is still an active development branch, so there may be rough edges.
|
||||
|
||||
Switching to `develop`:
|
||||
|
|
@ -67,6 +70,10 @@ If switching to the develop build, it is recommended to also use the [develop](h
|
|||
|
||||
### Nightly
|
||||
|
||||
[](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly)
|
||||
|
||||
**This branch will have squashed commits which can cause `git pull`/`git fetch` to error you can use `git reset origin/nightly --hard` to fix the branch.**
|
||||
|
||||
There is also a [nightly](https://github.com/meisnate12/Plex-Meta-Manager/tree/nightly) build which will have the absolute latest version of the script, but it could easily break, there is no guarantee that it even works, and any new features will not be documented.
|
||||
|
||||
Switching to `nightly`:
|
||||
|
|
|
|||
Loading…
Reference in a new issue