create screen casting and reverse tethering doc #30

Merged
merged 17 commits into from Dec 14, 2017

Conversation

Projects
None yet
3 participants
Contributor

lduboeuf commented Dec 5, 2017

don't know if this is the right place for this memo

lduboeuf added some commits Dec 5, 2017

Create screencasting.rst
reminder for screen casting or recording
Create reverse-tethering.rst
add a memo for reverse tethering
Update index.rst
add reverse-tethering doc

@lduboeuf lduboeuf changed the title from create screen casting doc to create screen casting and reverse tethering doc Dec 5, 2017

+Some users may don't have an available wifi connection for their phone nor a data subscription from their mobile provider.
+This short tutorial will help you to connect your Ubuntu Touch to your computer to access internet.
+
+Prerequisite: Phone is connected to the computer with usb and developper mode enabled.
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

Small spelling change: developper to developer

+Steps:
+------
+
+1 - on phone: ``android-gadget-service enable rndis``
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

This numbering style does not work in the build output. Please use the following:

userguide/advanceduse/screencasting.rst
+
+On computer side:
+-----------------
+ For real time casting:
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

Please do not indent here.

userguide/advanceduse/screencasting.rst
+
+ Prepare your computer to listen to a tcp port(here 1234) and forward stream to a video player (here mplayer):
+
+ nc -l -p 1234 | gzip -dc | mplayer -demuxer rawvideo -rawvideo w=384:h=640:format=rgba -
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

Use two colons followed by an indented line to create a code block. For example...

[...]and forward stream to a video player (here mplayer)::

    nc -l[...]
userguide/advanceduse/screencasting.rst
+On Ubuntu Touch:
+----------------
+
+ mirscreencast -m /run/mir_socket --stdout --cap-interval 1 -s 384 640 | gzip -c | nc 10.42.0.209 1234
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

Please add a statement followed by two colons (as mentioned above) to explain this command and force Sphinx to create a code block.

userguide/advanceduse/screencasting.rst
+References
+----------
+
+* initial source: https://wiki.ubuntu.com/Touch/ScreenRecording`
@UniversalSuperBox

UniversalSuperBox Dec 5, 2017

Member

There's an extraneous backtick (`) in this line

Contributor

lduboeuf commented Dec 5, 2017

right i think i will install sphinx locally or by using an editor to avoid wasting your time at reviewing text formating :) i'm so used to Markdown now... and github preview don't render correctly rst file i guess.

lduboeuf added some commits Dec 5, 2017

Update ssh.rst
add key generation section
Update screencasting.rst
add example script, 
add comments on commands
Contributor

lduboeuf commented Dec 6, 2017

ok seems to be good i hope

I really like this. Just a couple of nitpicky changes, and we'll be ready to go!

+
+Prerequisite: Phone is connected to the computer with usb and developer mode enabled.
+
+Steps:
@UniversalSuperBox

UniversalSuperBox Dec 8, 2017

Member

Remove colons from headings.

+
+2. on computer: get your rndis ip address e.g:``hostname -I``
+
+3. on phone:
@UniversalSuperBox

UniversalSuperBox Dec 8, 2017

Member

Please capitalize the first letter of every point.

lduboeuf and others added some commits Dec 8, 2017

Contributor

lduboeuf commented Dec 13, 2017

lol, sorry :)

Other question: i would like to put an extra file ( say a bash script ) put don't know where to put it (same folder, assets folder, other folder ?)

Member

UniversalSuperBox commented Dec 14, 2017

Hmm, good question. Looking at how the Godot engine does it, I'd say place the file inside of a files directory in the same directory as the RST you're editing.

Contributor

lduboeuf commented Dec 14, 2017

alright, done

@UniversalSuperBox UniversalSuperBox merged commit 1301d89 into ubports:master Dec 14, 2017

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment