diff mbox

[1/4] docs: Move README file to root

Message ID 1393784504-11327-2-git-send-email-maxime.hadjinlian@gmail.com
State Accepted
Headers show

Commit Message

Maxime Hadjinlian March 2, 2014, 6:21 p.m. UTC
Move the README file from the subdirectory doc to the root.

Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
---
 docs/README => README | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename docs/README => README (100%)

Comments

Thomas Petazzoni March 2, 2014, 8:41 p.m. UTC | #1
Dear Maxime Hadjinlian,

On Sun,  2 Mar 2014 19:21:41 +0100, Maxime Hadjinlian wrote:
> Move the README file from the subdirectory doc to the root.
> 
> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
> ---
>  docs/README => README | 0
>  1 file changed, 0 insertions(+), 0 deletions(-)
>  rename docs/README => README (100%)

But isn't this README completely crappy as a general presentation of
Buildroot? Shouldn't it be replaced by a better README that contains
some more relevant details?

Of course, I'll take your patch as is, hoping that someone will take on
the job of writing a better README :)

Thomas
Maxime Hadjinlian March 2, 2014, 10:54 p.m. UTC | #2
Hi Thomas, all
On Sun, Mar 2, 2014 at 9:41 PM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
> Dear Maxime Hadjinlian,
>
> On Sun,  2 Mar 2014 19:21:41 +0100, Maxime Hadjinlian wrote:
>> Move the README file from the subdirectory doc to the root.
>>
>> Signed-off-by: Maxime Hadjinlian <maxime.hadjinlian@gmail.com>
>> ---
>>  docs/README => README | 0
>>  1 file changed, 0 insertions(+), 0 deletions(-)
>>  rename docs/README => README (100%)
>
> But isn't this README completely crappy as a general presentation of
> Buildroot? Shouldn't it be replaced by a better README that contains
> some more relevant details?
Well... It's not *that* crappy. It's may be badly written or organized
but at least it exists and show some pointers to a starting user.
>
> Of course, I'll take your patch as is, hoping that someone will take on
> the job of writing a better README :)
I am sure since this file will be seen by much more people, someone
will write a better one, I could try myself at that job but I'm quite
awful with documentation writing :)
>
> Thomas
> --
> Thomas Petazzoni, CTO, Free Electrons
> Embedded Linux, Kernel and Android engineering
> http://free-electrons.com
diff mbox

Patch

diff --git a/docs/README b/README
similarity index 100%
rename from docs/README
rename to README