Skip to content

Commit 80b254f

Browse files
committed
Readme
1 parent d723ea2 commit 80b254f

File tree

1 file changed

+33
-55
lines changed

1 file changed

+33
-55
lines changed

README.md

Lines changed: 33 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
55
[![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS-lightgrey.svg)](https://github.com/yourusername/prolink-cpp)
66

7-
A modern (C++17) library for interacting with Pioneer DJ equipment using the **Pro DJ Link** protocol. Monitor beats, sync to tempo masters, and control CDJs.
7+
A modern (C++17 my application limits me to 17 or older features) library for interacting with Pioneer DJ equipment using the **Pro DJ Link** protocol. Monitor beats, sync to tempo masters, and control CDJs.
88

99
---
1010

@@ -251,35 +251,6 @@ ctest --output-on-failure
251251

252252
---
253253

254-
## Credits & Acknowledgments
255-
256-
This library would not be possible without the reverse-engineering work done by:
257-
258-
### [dysentery](https://github.com/Deep-Symmetry/dysentery) by Deep Symmetry
259-
260-
**Credit:** James Elliott ([@brunchboy](https://github.com/brunchboy)) and the Deep Symmetry team deserve credit for their meticulous documentation.
261-
- [dysentery Documentation](https://djl-analysis.deepsymmetry.org/)
262-
- [GitHub Repository](https://github.com/Deep-Symmetry/dysentery)
263-
264-
### [prolink-connect](https://github.com/EvanPurkhiser/prolink-connect) by Evan Purkhiser
265-
266-
prolink-connect is a full-featured library for Node.js that implements not only the core Pro DJ Link protocol but also the database query protocol for track metadata, beat grids, waveforms, and artwork.
267-
268-
- [GitHub Repository](https://github.com/EvanPurkhiser/prolink-connect)
269-
- [NPM Package](https://www.npmjs.com/package/prolink-connect)
270-
271-
### [beat-link](https://github.com/Deep-Symmetry/beat-link) by Deep Symmetry
272-
273-
- [GitHub Repository](https://github.com/Deep-Symmetry/beat-link)
274-
- [Documentation](https://deepsymmetry.org/beatlink/)
275-
276-
### Related Projects
277-
- [**beat-link-trigger**](https://github.com/Deep-Symmetry/beat-link-trigger) - Application for triggering events based on CDJ activity
278-
- [**crate-digger**](https://github.com/Deep-Symmetry/crate-digger) - Rekordbox database analysis
279-
- [**open-beat-control**](https://github.com/RubenInglada/open-beat-control) - Python library for Pro DJ Link
280-
281-
---
282-
283254
## Implementation Status
284255

285256
This port is a work in progress and does not implement all aspects of the prolink protocol yet.
@@ -297,7 +268,6 @@ This port is a work in progress and does not implement all aspects of the prolin
297268
- Thread-safe API with exception-safe callbacks
298269
- Config validation with error reporting
299270

300-
301271
---
302272

303273
## Known Issues & Limitations
@@ -306,14 +276,12 @@ This port is a work in progress and does not implement all aspects of the prolin
306276
- **Currently**: Linux and macOS only (POSIX sockets)
307277

308278
### Protocol Coverage
309-
- **Implemented**: Beat sync, status monitoring, device discovery, master handoff
310279
- **Not implemented**: Database queries, waveforms, artwork, NFS access
311280

312-
313281
---
314282

315283
### External Resources
316-
- [dysentery Protocol Analysis](https://djl-analysis.deepsymmetry.org/) - Authoritative protocol docs
284+
- [dysentery Protocol Analysis](https://djl-analysis.deepsymmetry.org/)
317285
- [Pro DJ Link Research](https://github.com/Deep-Symmetry/dysentery/blob/master/doc/Analysis.pdf) - Protocol PDF
318286

319287
---
@@ -343,39 +311,49 @@ cmake --build .
343311
ctest --output-on-failure
344312
```
345313

346-
---
314+
### Production Use
315+
This library has been tested with:
316+
- CDJ-3000
347317

348-
## License
349318

350-
MIT License - see [LICENSE](LICENSE) file for details.
319+
## Community & Support
351320

352-
### Third-Party Licenses
353-
- **GoogleTest** - BSD 3-Clause License (testing only)
321+
- **Issues:** [GitHub Issues](https://github.com/yourusername/prolink-cpp/issues)
322+
- **Discussions:** [GitHub Discussions](https://github.com/yourusername/prolink-cpp/discussions)
354323

355324
---
356325

357-
## Community & Support
358326

359-
- **Issues:** [GitHub Issues](https://github.com/yourusername/prolink-cpp/issues)
360-
- **Discussions:** [GitHub Discussions](https://github.com/yourusername/prolink-cpp/discussions)
327+
## Credits & Acknowledgments
328+
329+
This library would not be possible without the reverse-engineering work done by:
361330

362-
### Related Communities
363-
- [Deep Symmetry Discord](https://discord.gg/pcuxBmF) - DJ technology hacking
364-
- [r/Beatmatch](https://reddit.com/r/Beatmatch) - DJ community
331+
### [dysentery](https://github.com/Deep-Symmetry/dysentery) by Deep Symmetry
365332

366-
---
333+
James Elliott ([@brunchboy](https://github.com/brunchboy)) and the Deep Symmetry team deserve credit for their meticulous documentation.
334+
- [dysentery Documentation](https://djl-analysis.deepsymmetry.org/)
335+
- [GitHub Repository](https://github.com/Deep-Symmetry/dysentery)
367336

368-
### Production Use
369-
This library has been tested with:
370-
- CDJ-3000
337+
### [beat-link](https://github.com/Deep-Symmetry/beat-link) by Deep Symmetry
338+
339+
- [GitHub Repository](https://github.com/Deep-Symmetry/beat-link)
340+
- [Documentation](https://deepsymmetry.org/beatlink/)
341+
342+
### [prolink-connect](https://github.com/EvanPurkhiser/prolink-connect) by Evan Purkhiser
343+
344+
- [GitHub Repository](https://github.com/EvanPurkhiser/prolink-connect)
345+
- [NPM Package](https://www.npmjs.com/package/prolink-connect)
346+
347+
### Related Projects
348+
- [**beat-link-trigger**](https://github.com/Deep-Symmetry/beat-link-trigger) - Application for triggering events based on CDJ activity
349+
- [**crate-digger**](https://github.com/Deep-Symmetry/crate-digger) - Rekordbox database analysis
350+
- [**open-beat-control**](https://github.com/RubenInglada/open-beat-control) - Python library for Pro DJ Link
371351

372352
---
373353

374-
## Special Thanks
354+
## License
375355

376-
Special recognition to:
377-
- **James Elliott ([@brunchboy](https://github.com/brunchboy))** - For dysentery and the incredible documentation effort
378-
- **Evan Purkhiser ([@EvanPurkhiser](https://github.com/EvanPurkhiser))** - For prolink-connect and API design inspiration
379-
- **The Deep Symmetry team** - For their continued work on beat-link and the DJ technology ecosystem
380-
- **Pioneer DJ** - For creating the Pro DJ Link protocol
356+
MIT License - see [LICENSE](LICENSE) file for details.
381357

358+
### Third-Party Licenses
359+
- **GoogleTest** - BSD 3-Clause License (testing only)

0 commit comments

Comments
 (0)