veejay icon indicating copy to clipboard operation
veejay copied to clipboard

Documentation Review

Open game-stop opened this issue 8 years ago • 4 comments

All documentation should be reviewed and updated

In general:

  • ~~Link to documents from main README (link to video codecs, link to audio , etc etc)~~ a7549f2245173d9b7eee9ac2ddb970b889cda680 & 9903d30dc39d344c346a133e77b335b8cd138096
  • consistent use of terminology
  • correctness/spelling
  • verify instructions
  • Use markup as described in #3
  • clean redundant info/files (HowtoVideoCodecs vs README.video_formats ...) , consistent file names and extension
  • README.md and veejay-HOWTO.html (in near future .md) are good candidate to be generated from others single documents.
  • libjpeg62 --> libjpeg62-turbo
  • optional dep : aalib-dev (lvdasciiart) / open-mp ( bloom fx)

News features to documents:

  • transition - https://github.com/c0ntrol/veejay/issues/242
  • master fx chain list - https://github.com/c0ntrol/veejay/issues/148
  • sample loops numbering - https://github.com/c0ntrol/veejay/issues/181
  • reloaded -t -S
  • reloaded https://github.com/c0ntrol/veejay/issues/131 , and click over fx chain / sample bank
  • reloaded VIMS panel
  • ....

Documents to update:

  • ~~veejay.1~~ (done) #227
  • sayVIMS.1
  • ~~veejay-HOWTO.html~~ --now--> veejay-HOWTO.md (done)... ~~fixme: check Dependencies, Hardware Conf, Popular Packages , GPL~~
  • ~~HowtoCache.txt~~ (done) merge into README.memory (e3fc99b)
  • ~~HowtoPlugins.txt~~ (done) ---> .md ( 03830064fd & f3603b9 )
  • HowtoVeejay-PureData.html
  • ~~README.alpha~~ (done) ---> .md ( 85d29f9 )
  • ~~README.android~~ (done) ---> .md ( 4aaf52c )
  • ~~/README.md~~ (done) ( f60a9ca)
  • ~~README.performance~~ (done) ---> .md ( b8d2079 )
  • ~~README.video_formats.txt~~ (done) merged has README.video-codec (a3a15f3)
  • ~~VIMS.txt~~ (done) ---> .md (#224)
  • ~~HowToDebugging.txt~~ (done) ---> .md (#224)
  • ~~HowtoCompile.txt~~ (done) --> .md (#224)
  • HowtoUbuntu.txt
  • ~~HowtoVideoCodecs.txt~~ (done) merged has README.video-codec (a3a15f3)
  • ~~Installation.md~~
  • NET.txt
  • ~~README.audio~~ (done) ---now---> README.audio.md
  • ~~README.memory~~ (done) ---now---> README.memory.md (e3fc99b)
  • ~~README.quickstart~~ (done) ---now-> README.quickstart.md (a2bd25 + 735a36fd0)
  • ~~README.whatis~~ --now---> README.whatis.md (done)
  • YCbCr.txt
  • video-wall.md
  • ~~veejay-server/README~~ (done)
  • README.security
  • Check for README in various location (example vj-server/test/README )

see also : #170 #172 #193

game-stop avatar Dec 10 '15 22:12 game-stop

Great stuff Niels I really observe with great joy how things around veejay are developing. I must say I can't wait to actually get deeper into the hacking side as well, but my resources have been more than exhausted during the last weeks for writing my audiovisual rendering stuff, working full-time, setting up that irc server + writing a bot, writing my blogging page, getting involved in a dataflow/patching related project with a former colleague, learning supercollider, etc. pp. you know how it goes..

If you watch closely at the flow diagram on the etudes page, you'll see that veejay is the next step in the pipeline, so don't worry I'll be getting there soon. For the time being, keep up the good work!

drlight-code avatar Dec 11 '15 08:12 drlight-code

Thanks!

The diagram looks good to me; looks like its about time to revive the multicast option in libvjnet ...

If the veejay instances are all running on the local machine, you can interconnect them via shared memory which would be preferable to opening network streams

game-stop avatar Dec 11 '15 18:12 game-stop

multicast steaming is functional again; however for high resolution video the bandwidth demands are substantial ( ~40 MB/sec for 1280x720 ). the frames are compressed with LZO, another option would be to use one of the mpeg family encoders

game-stop avatar May 14 '16 21:05 game-stop

work in progress : https://github.com/d-j-a-y/veejay/tree/djay_help_update

d-j-a-y avatar Jan 28 '19 14:01 d-j-a-y