raspberrypi / documentation Goto Github PK

config-txt.md

wireless/README.md

xbmc.md

python-games.md

sd-cards.md

Hi,

I just read your documentation on how to install the disk image for Raspbian to a SD card on OS X.
It says that the user should use dd with /dev/diskn. On OS X, /dev/rdiskn is a lot faster with SD cards, so I guess that would make the process simpler and faster for users.

You write about it in the alternative method description, but it should be used in the first place.

Cheers,
Lukas

I have added installation instructions for NGINX.
Shall I submit a pull request?

terminal.md

Any chance of adding some documentation on how to use a Raspberry Pi as the controller for a simple robot?

raspi-config.md

I propose enabling the github wiki and making it a working area for documentation.
This enables many more to provide bits and pieces of documentation, and over time it can evolve into something that is fit for inclusion in the offical documentation.

For me personally, with the current situation with PR's and review process, it's a barrier to participation. It's too cumbersome compared to updating a wiki, and since english is not my native language, I probably have to go through PR iterations because of that.

I see it much like the relationship between the upstream Linux kernel source and the raspberrypi/linux source. Much of the BCM2708 stuff is not fit for upstream inclusion, but it's useable anyway.

Hence I would like a middleground that is easy to use.
Don't get me wrong, I like the idea of having high quality documentation, but even getting low quality documentation can be hard for a community project.

I have missed a Raspberry Pi wiki since the beginning. I felt elinux.org was sort of outside the Pi community. For me, a Pi wiki using the forum login would be great.

I have only written one page on elinux and some more lines on other pages, but moving it here is currently to much work. It took me a long time to even write that page on elinux, because I had to apply for a username to write it.

My point is: please do the uttermost to keep the barriers for documentation writing as low as possible.

installing-codecs.md

I would like to provide a chapter on Java under the "usage" section of the guide - I wanted to check whether it would likely be accepted first before I start writing it.

http://www.raspberrypi.org/documentation/

It currently says:

• Remote Access
  • Accessing your Pi remotely via SSH, VLC or over the web

It should say:

• Remote Access
  • Accessing your Pi remotely via SSH, VNC or over the web

I can't find the index page on the repo so just made an issue.

usage/minecraft/README.md

I have just worked through this example and could not get the PHP to work.

The instructions say to enter

I believe the ; on the 3 examples needs to be replaced by ?>

As a newcomer to php I would like to see the complete index.php file, when it did not work I was not sure whether I had put it in the wrong place, in the body not the heaer etc.

I believe the easiest way to set up a a remote desktop session is not listed there:

http://www.raspberrypi.org/documentation/remote-access/README.md

It is a two step thing without the need for any configuration.
On PI:
STEP1) sudo apt-get install xrdp

STEP2) on other platform, use RDP (remote desktop connection) (available on android/IOs/ MAC/ Windows(obviously).

IOS (Microsoft Remote Desktop):
https://itunes.apple.com/ca/app/microsoft-remote-desktop/id715768417?mt=12

Android:

http://play.google.com/store/apps/details?id=com.microsoft.rdc.android

Benoit

Was running through the quickstart guide with a primary school pupil today and she came across heaphones, which should be headphones.

Was - Heaphones or earphones with a 3.5mm jack will work with your Raspberry Pi.
Should be - Headphones or earphones with a 3.5mm jack will work with your Raspberry Pi.

Same with the title of the section

http://www.raspberrypi.org/help/quick-start-guide/

python.md

Can't find this on the webpage.

I just went through the example script camera.sh and noted that a directory used in the script doesn't exist. I think this should be mentioned or become an explicit step in the guide.

root.md

According to usage/audio/README.md, omxplayer should output audio over whatever default audio device you've configured in raspi-config.
However it seems that when video is being displayed over HDMI, omxplayer ignores the value set by raspi-config, and to get audio playing over the headphone port I actually have to do 'omxplayer -o local la.mp3`.

Can somebody more familiar with omxplayer confirm this is indeed the expected behaviour? If so, I'll have a go at updating the usage/audio/README.md page.

gpio.md

Audio applications on the Raspberry Pi have two dependencies for low-latency reliable operation; a real time kernel and an audio interface. This generally means two patchsets to apply to the kernel sources

• The -rt patchsets
• The Wolfson Microelectronics Raspberry Pi audio board codec, Hifiberry or other ADC/DAC board

The process for this is relatively straightforward (applying two patchsets, enable some configuration options in 'make menuconfig' or applying a patch to the config file) but worth documenting.

As it is a generalized process and the audio patches can be omitted for other real time applications, I'd like to contribute documentation on this topic to the main documentation repository. I've been documenting this for the OpenOB AoIP project and running it by some users of the project to check it out.

It may also be worth splitting the two topics into two different pages ("Real-time Kernel" and "Wolfson Audio Board Kernel").

Happy to provide these as a pull request if it's something that should be in the central docs.

camera.md

mathematica

Apply @lauraclay's Mathematica usage guide fixes from commit e4468fe in raspberrypilearning

Seeing as this guide is aimed at beginners, might images beside each port in https://github.com/gbaman/documentation/blob/master/setup/monitor-connection.md be a good idea?

Also a graphic showing which port on the Raspberry Pi is for example HDMI. When I was starting out, I had no idea what DVI was for example.

When selecting documentation from the Help page, the documetation page (www.raspberrypi.org/documentation) opens and the black underline under the green HELP disappears. Clicking on the search icon at the right does not open the search bar.
Maybe because documentation is not located under help in the file hierarchy???

rc.local given as only example. Need to cover alternatives for other cases.

I have created a suggested root.md update. Please take a look and merge if appropriate. I've written it in beginners language which I think matches the style of the site.

I have not included information on editing the sudo file as that is already covered in users.md although could perhaps fit in root.md instead?

Would you like me to update some of the other empty Linux documents? I am an experienced Linux administrator and tech reviewer.

When appending to the authorized_keys file, I find it easier to use the built in command:

 $ ssh-copy-id -i ~/.ssh/id_rsa.pub [email protected]

Which gives the following output

[email protected]'s password: 
Now try logging into the machine, with "ssh '[email protected]'", and check in:

  ~/.ssh/authorized_keys

to make sure we haven't added extra keys that you weren't expecting.

The advantage of this command is it has no backticks or pipes to worry about.

packaging.md

the raspistill command now contains the -tl (timelapse) parameter.

/master/usage/camera/raspicam/timelapse.md only mentions cron which presents file overwriting issues the the -tl parameter was designed to avoid.

Would be happy to leave the cron section on the page but add and promote to the top details and examples for raspistill -tl

scp.md

This is a 'meta issue' rather than an issue affecting any particular page... ;-)

For all the pages under http://www.raspberrypi.org/documentation/ (which get auto-updated from this GitHub repo) the page's TITLE tags are always set to just

<title>Raspberry Pi</title>

It would be nice if this could also include the title of the page you're currently viewing, which would a) make each tab in a multi-tabbed browser easier to identify and b) make it easier to navigate backwards/forwards through your browser's history.

In your Linux installation guide you describe how to write the Image with ImageWriter but this tool is not available since Ubuntu Linux 13.04.

installing-images/linux.md

There are several stub pages in documentation/troubleshooting that require filling out.

At first when @bennuttall created the troubleshooting/usb page I was tempted just to cross-link to the "article" I already wrote on the USB hardware and its differences to EHCI, but then the obverse argument became apparent: users will hit (or be directed to) the troubleshooting guide without any understanding of the underlying issues, nor do they wish to know about why OTG is different from EHCI.

The way I see it, the Pi lacks tier 1 technical support. Well, it doesn't actually: it has a very well staffed and managed user forum but this is an energy barrier to people that just want their Pi to work.

I propose scoping the troubleshooting section of the documentation tree to an apparent symptom/recommended solution based approach. The top page should be "what is wrong with your Pi?" with the top four or five links directly linking to the most common causes of problems. Inexperienced users are typically terrible at diagnosing the root issue with unfamiliar hardware: a simple "my Pi doesn't do X" -> "page full of solutions for X" should nab 80% of nonfunctional cases.

ftp.md

See quotation marks on http://www.raspberrypi.org/documentation/hardware/raspberrypi/power.md for an example. It looks like the markdown renderer is outputting in Latin-1 (ISO-8859-1). However, the web-server isn't specifying a character encoding when the page is served so most browsers (at least FF and Chrome which I've tested so far) assume UTF-8 (quite reasonably in the absence of any further information). A quick fix would be to set the content-type header to something like Content-Type: text/html; charset=iso-8859-1 but ultimately the markdown renderer should be set to output UTF-8 (sooner or later someone's going to need the odd international character after all).

minecraft.md

Another meta-issue...

If you go to http://www.raspberrypi.org/documentation/ (or any of it's sub-pages) and then click on the white magnifying glass search icon, nothing happens!
Until this gets implemented, maybe a box saying something like "Documentation can't be searched yet" could be displayed, when the magnifying glass is clicked on?

audio-config.md

users.md

The links on the page http://www.raspberrypi.org/documentation/hardware/raspberrypi/schematics.md reference PDFs. However, the web-server currently sets the content type of the response to application/octet-stream instead of application/pdf. The latter permits some browsers (FF, Chrome, etc.) to render internally or offer additional reading options instead of simply downloading the file (i.e. this is a minor enhancement, not a bug)

As far as I know, there's no recent kernel headers package for Raspian.
To remedy this, I made a tool that downloads the kernel source used to build the running kernel
rpi-source recognizes rpi-update kernels and Raspian kernels.

With the whole kernel source available, it's also possible to build in-tree modules.

I have tried to make it as newbie friendly as I possibly could, including several examples.

Maybe this tool could be mentioned on the linux/kernel/headers.md page?

Wiki: https://github.com/notro/rpi-source/wiki
Examples: https://github.com/notro/rpi-source/wiki/Examples-on-how-to-build-various-modules

scratch.md

Leoxsys Wireless 802.11n USB LEO-NANO150N is not working in Raspberry PI with Raspian OS. I have code which can be integrated with modification. Request for advice.

python-picamera