Skip to content

Commit

Permalink
update formatting and install info
Browse files Browse the repository at this point in the history
  • Loading branch information
harrypm committed Jun 25, 2024
1 parent 433690c commit 3d4f5bd
Showing 1 changed file with 31 additions and 16 deletions.
47 changes: 31 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,52 @@
This is the GitHub repo for ld-decode. This is the (hopefully stable) merged development branch.


# Documentation
# Installation & Downloads


Documentation is available via the GitHub wiki. This includes installation and usage instructions. Start with the wiki if you have any questions.
- [Linux](https://github.com/happycube/ld-decode/wiki/Installation)
- [Windows](https://github.com/oyvindln/vhs-decode/wiki/Windows-Build)
- [MacOS](https://github.com/oyvindln/vhs-decode/wiki/MacOS-Build)

The wiki also includes details of the project's IRC channel and Facebook group.
You will find self-contained binary bundled ready-to-use packages of current and future builds of the decoders and ld-x tools in the [vhs-decode repository](https://github.com/oyvindln/vhs-decode/wiki/), combining `ld-decode`, `vhs-decode`, `cvbs-decode` & `hifi-decode` into one package, alongside [tbc-video-export](https://github.com/JuniorIsAJitterbug/tbc-video-export/releases) a more fluid cross format export tool to make CVBS/S-Video type TBC files into video files.

If you intend on contributing or have general questions please join the Discord server which has the entire family of decode projects developers on it (or IRC if you must) as the Facebook group is mostly inactive.

https://github.com/happycube/ld-decode/wiki
> [!NOTE]
> vhs-decode is not limited to VHS and supports many tape media formats!
https://discord.gg/pVVrrxd
> [!IMPORTANT]
> The decoders and tools are CLI - Commandline Interface, only ld-analyse & hifi-decode have a graphical GUI interface.

## *If in doubt - Read the Wiki!*
# Documentation


# Source code locations
Documentation is available via the GitHub wiki's. This includes installation and usage instructions.

Start with the wiki if you have any questions.

The source is split roughly into three parts:
If you only care about Laserdiscs please read

- ld-decode - The main python application responsible for decoding lds/ldf LaserDisc RF samples into tbc files (time-base corrected framed video)
- ld-decode-tools (under the tools/ directory) - The tool-chain for processing tbc files in various ways
- scripts (under the scripts/ directory) - Various scripts to assist with dev and decoding
- [LD-Decode Wiki](https://github.com/happycube/ld-decode/wiki)

If you want to learn about FM RF archival overall and other media formats such as tape or RAW Composite/CVBS decoding then please read:

- [VHS-Decode Wiki](https://github.com/oyvindln/vhs-decode/wiki/)

## Self-contained builds

The wiki also includes details of the decode community's Discord / IRC Bridge and the now legacy Facebook group.

You will find Windows/MacOS/Linux self-contained binaries for the entire decode family workflow here:
If you intend on contributing or have general questions please join the [Discord server](https://discord.gg/pVVrrxd) which has the entire family of decode projects developers on it (or IRC if you must) as the Facebook group is mostly inactive there is also the [r/vhs-decode](https://new.reddit.com/r/vhsdecode/) subreddit that is fairly active.

- [vhs-decode repository](https://github.com/oyvindln/vhs-decode/releases/) - VHS and many other tape formats are supported by the FM RF archival method today.
- [tbc-video-export repository](https://github.com/JuniorIsAJitterbug/tbc-video-export/releases) - More fluid and simple export workflow tool for CVBS/S-Video type TBC files.

## *If in doubt - Read the Wiki!*


# Source code locations


The source is split roughly into three parts:

- ld-decode - The main Python application responsible for decoding lds/ldf LaserDisc RF samples into tbc files (time-base corrected framed video)
- ld-decode-tools (under the tools/ directory) - The tool-chain for processing tbc files in various ways
- scripts (under the scripts/ directory) - Various scripts to assist with dev and decoding

0 comments on commit 3d4f5bd

Please sign in to comment.