Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation Review #76

Open
game-stop opened this issue Dec 10, 2015 · 4 comments
Open

Documentation Review #76

game-stop opened this issue Dec 10, 2015 · 4 comments
Assignees
@game-stop
Labels
documentation

Comments

@game-stop
Copy link
Owner

game-stop commented Dec 10, 2015 •
edited by d-j-a-y
Loading

All documentation should be reviewed and updated

In general:

  • Link to documents from main README (link to video codecs, link to audio , etc etc) a7549f2 & 9903d30
  • consistent use of terminology
  • correctness/spelling
  • verify instructions
  • Use markup as described in Decide upon unified documentation system #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:

Documents to update:

  • veejay.1 (done) help update - man veejay #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 ( 0383006 & 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 (Vims.md review ++ #76 #224)
  • HowToDebugging.txt (done) ---> .md (Vims.md review ++ #76 #224)
  • HowtoCompile.txt (done) --> .md (Vims.md review ++ #76 #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 + 735a36f)
  • 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 game-stop mentioned this issue Dec 10, 2015
Closed
@drlight-code
Copy link
Collaborator

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!

@game-stop
Copy link
Owner Author

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 game-stop self-assigned this Dec 15, 2015
This was referenced Feb 10, 2016
Closed
Closed
Closed
@game-stop
Copy link
Owner Author

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

@d-j-a-y
Copy link
Collaborator

d-j-a-y commented Jan 28, 2019

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

d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 3, 2019
@d-j-a-y
Improve Help (game-stop#76) - backport db7215 + fix
7175793
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 3, 2019
@d-j-a-y
Help (game-stop#76 Wip) - veejay-server/README : updated
f368cea
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 8, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) : vj-HOWTO.md progress
529de4c 
* todo sayVIMS --> end
* fix minor in VIMS.txt accordingly
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 8, 2019
@d-j-a-y
Improve Help ( game-stop#76 wip) : review veejay-HOWTO.md - progress
d1797f9 
* todo from 4.3 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 9, 2019
@d-j-a-y
Improve help (game-stop#76) : veejay-howto.html --> veejay-howto.md
7554138 
todo 4.5.3 network --> end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 9, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : veejayhowto.html --> veejayhowto.md…
cab734d 
… (progress)

* remove 4.6 "other utilities" section
* split VIMS into section (global and sayVIMS)
* rewrite sayVIMS section
* rewrite 4.5.3 network
* + minors

- todo from 5 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Improve Help (game-stop#76) - backport db7215 + fix
4de28b5
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Help (game-stop#76 Wip) - veejay-server/README : updated
f01247d
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) : vj-HOWTO.md progress
2f46604 
* todo sayVIMS --> end
* fix minor in VIMS.txt accordingly
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Improve Help ( game-stop#76 wip) : review veejay-HOWTO.md - progress
40b1d53 
* todo from 4.3 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Improve help (game-stop#76) : veejay-howto.html --> veejay-howto.md
bf0e50a 
todo 4.5.3 network --> end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : veejayhowto.html --> veejayhowto.md…
9f783a7 
… (progress)

* remove 4.6 "other utilities" section
* split VIMS into section (global and sayVIMS)
* rewrite sayVIMS section
* rewrite 4.5.3 network
* + minors

- todo from 5 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 10, 2019
@d-j-a-y
Update help (game-stop#76 wip) veejayHOWTO : done -> to be review
40e53a6 
* Specialy "Dependencies", "Hardware Conf", "Popular Packages" & GPL chapters
need to be review ...
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 11, 2019
@d-j-a-y
Improve help (game-stop#76 wip) : Memory concern (HowtoCache + README…
e3fc99b 
….memory)

* README.memory --> README.memory.md
* Adpat content from HowtoCache into README.memory
* Remove HowtoCache
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 11, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (done)
0383006 
* howtoplugins.txt --> .md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 12, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (redone)
f3603b9 
* Add sections : plugpack , find plug, plug default value
* Clean duplicate into installation.md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 12, 2019
@d-j-a-y
Improve Doc (game-stop#76 wip) - README.alpha --> md (done)
85d29f9 
* Formating
* rename --> md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 13, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) Readme.android --> .md (done)
4aaf52c 
* Comment android reference from /README.md - where that app is ?
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 14, 2019
@d-j-a-y
Update help (game-stop#76 wip) - README.performance --> md
b8d2079 
* perfo - md
* whatis : add subsections
* + fix intralinks
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Feb 14, 2019
@d-j-a-y
update help (game-stop#76 wip) - /README.md - add intralink
4179b64 
* Howtoplugins
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (done)
c921e0b 
* howtoplugins.txt --> .md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (redone)
5bd86e7 
* Add sections : plugpack , find plug, plug default value
* Clean duplicate into installation.md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Improve Doc (game-stop#76 wip) - README.alpha --> md (done)
458b6fa 
* Formating
* rename --> md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) Readme.android --> .md (done)
46074db 
* Comment android reference from /README.md - where that app is ?
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Update help (game-stop#76 wip) - README.performance --> md
18255b5 
* perfo - md
* whatis : add subsections
* + fix intralinks
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
update help (game-stop#76 wip) - /README.md - add intralink
1e7b04b 
* Howtoplugins
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : HowToVideoCode ---> README.video-co…
c076a1b 
…dec (done)

* remove README.video_formats.txt
* rename HowToVideoCode ---> README.video-codec
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 5, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : Readme.md --> dependecies
e6822f8
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Help (game-stop#76) - backport db7215 + fix
44a7f69
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Help (game-stop#76 Wip) - veejay-server/README : updated
573a509
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) : vj-HOWTO.md progress
f5ae116 
* todo sayVIMS --> end
* fix minor in VIMS.txt accordingly
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Help ( game-stop#76 wip) : review veejay-HOWTO.md - progress
a65515d 
* todo from 4.3 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve help (game-stop#76) : veejay-howto.html --> veejay-howto.md
a8c81ce 
todo 4.5.3 network --> end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : veejayhowto.html --> veejayhowto.md…
be0478d 
… (progress)

* remove 4.6 "other utilities" section
* split VIMS into section (global and sayVIMS)
* rewrite sayVIMS section
* rewrite 4.5.3 network
* + minors

- todo from 5 to end
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Update help (game-stop#76 wip) veejayHOWTO : done -> to be review
9267420 
* Specialy "Dependencies", "Hardware Conf", "Popular Packages" & GPL chapters
need to be review ...
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve help (game-stop#76 wip) : Memory concern (HowtoCache + README…
6e88c07 
….memory)

* README.memory --> README.memory.md
* Adpat content from HowtoCache into README.memory
* Remove HowtoCache
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (done)
8451100 
* howtoplugins.txt --> .md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve help (game-stop#76 wip) - howtoplugins (redone)
094187c 
* Add sections : plugpack , find plug, plug default value
* Clean duplicate into installation.md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Doc (game-stop#76 wip) - README.alpha --> md (done)
b31ff2a 
* Formating
* rename --> md
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
ImproveHelp (game-stop#76 wip) Readme.android --> .md (done)
103413e 
* Comment android reference from /README.md - where that app is ?
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Update help (game-stop#76 wip) - README.performance --> md
1d096d6 
* perfo - md
* whatis : add subsections
* + fix intralinks
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
update help (game-stop#76 wip) - /README.md - add intralink
4acafb8 
* Howtoplugins
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : HowToVideoCode ---> README.video-co…
0cb5d70 
…dec (done)

* remove README.video_formats.txt
* rename HowToVideoCode ---> README.video-codec
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 15, 2019
@d-j-a-y
Improve Help (game-stop#76 wip) : Readme.md --> dependecies
330c7b1
game-stop added a commit that referenced this issue Jun 16, 2019
@game-stop
Merge pull request #216 from d-j-a-y/djay_help_update
09520da 
Help update (WIP) see #76 for progess
d-j-a-y added a commit to d-j-a-y/veejay that referenced this issue Jun 19, 2019
@d-j-a-y
UpdateHelp (game-stop#76 wip) : review /README.md + fix howto accordi…
f60a9ca 
…ngly
game-stop added a commit that referenced this issue Jun 23, 2019
@game-stop
Merge pull request #224 from d-j-a-y/djay_help_update
3e52b92 
Vims.md review ++ #76
This was referenced Jun 25, 2019
Merged
Merged
@d-j-a-y d-j-a-y mentioned this issue Jul 2, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@game-stop game-stop

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@d-j-a-y @drlight-code @game-stop