Skip to content

Commit 0a4de7b

Browse files
authored
Merge pull request #989 from simoninns/readmeupdate202512
Update readme to reflect documentation changes
2 parents 86c0030 + 97fc688 commit 0a4de7b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ld-decode is a GPL3 open-source project run entirely by volunteers and provided
1919

2020
Note that the main repo is under constant development and, while we strive to keep it stable, it is a part of the active development cycle. Contributors maintain ready-made binary builds which are far more suitable for end-users and are available for platforms such as Windows and Apple MacOS. The main ld-decode repo targets only Ubuntu (generally the current LTS version - although it's possible to compile the project on most Linux flavors).
2121

22-
If you'd like to download binaries or compile the project from source please see the project's wiki for detailed instructions.
22+
If you'd like to download binaries or compile the project from source please see the [ld-decode documentation](https://happycube.github.io/ld-decode-docs/) for detailed instructions.
2323

2424
## Building from Source
2525

@@ -43,9 +43,9 @@ For installation instructions after building, see **[INSTALL.md](INSTALL.md)** w
4343
# Documentation
4444

4545
> [!Important]
46-
> If in doubt read the wiki!
46+
> If in doubt read the documentation!
4747
48-
You can find the wiki here: [ld-decode Wiki](https://github.com/happycube/ld-decode/wiki)
48+
You can find the documentation here: [ld-decode documentation](https://happycube.github.io/ld-decode-docs/)
4949

5050

5151
# The decoding tool-chain
@@ -55,12 +55,14 @@ You can find the wiki here: [ld-decode Wiki](https://github.com/happycube/ld-dec
5555
5656
# Want to get involved?
5757

58-
The wiki includes details of the ld-decode community's Discord / IRC Bridge and the now legacy Facebook group.
58+
The documentation includes details of the ld-decode community's Discord / IRC Bridge and the now legacy Facebook group.
5959

6060
If you are interested in contributing or have general questions please join the [Domesday86 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.
6161

6262
For detailed information on how to contribute code, report bugs, or suggest enhancements, please see **[CONTRIBUTING.md](CONTRIBUTING.md)**.
6363

64+
You can also contribute to the project documentation, see the [ld-decode documentation github](https://github.com/happycube/ld-decode-docs) for details.
65+
6466
There is also a VHS specific subreddit [r/vhs-decode](https://new.reddit.com/r/vhsdecode/) that is fairly active.
6567

6668

0 commit comments

Comments
 (0)