tools icon indicating copy to clipboard operation
tools copied to clipboard

No README file or documentation included

Open JamesHagerman opened this issue 11 years ago • 8 comments

It would be wonderful if there was some kind of tutorial on how to use the tools in this repo.

If one already exists, maybe a readme file pointing to that tutorial could be added to the project?

JamesHagerman avatar Mar 12 '13 23:03 JamesHagerman

Upvote for this one!

Hipska avatar May 29 '13 20:05 Hipska

Upvote =)

pukster avatar Nov 28 '13 07:11 pukster

:+1:

Mikaela avatar Apr 07 '14 03:04 Mikaela

http://www.raspberrypi.org/documentation/linux/kernel/building.md

http://www.raspberrypi.org/documentation/hardware/computemodule/cm-emmc-flashing.md

lurch avatar Jun 26 '14 10:06 lurch

What's the gcc-linaro-arm-linux-gnueabihf-raspbian-x64 directory for? Should I use that on my 64bit Debian machine?

And yeah, a README file would be most welcome, even if that README would only point to the building.md document :wink: I'd have thought that http://elinux.org/Raspberry_Pi_Kernel_Compilation would be correct, but it differs from the building.md document linked above.

diederikdehaas avatar Dec 31 '14 15:12 diederikdehaas

@JamesHagerman @diederikdehaas is this still an issue?

Ruffio avatar Jun 27 '15 18:06 Ruffio

The master branch appears to stil lbe missing README.md.

Mikaela avatar Jun 27 '15 19:06 Mikaela

I just saw that there is now indeed a clarification on what to do on 64-bit systems :+1:

However, there are still 2 directories in tools/arm-bcm2708/ for where I haven't been able to find what they're good for. Based on the fact they haven't been updated in 3 years, I would assume that I probably shouldn't be using them. But I shouldn't have to assume. If they're not needed anymore, they should be deleted or something like that. If they still have a purpose it should be clarified what that purpose is and what/how it should be used. And a README.md is the usual way to do that.

Apart from that, it's basically standard practice to have a README.md to clarify what the purpose is of the repository and how to use it.

diederikdehaas avatar Jun 27 '15 19:06 diederikdehaas