[aerogear-dev] Project Info to all projects

[Daniel Passos]

Hey Lukás,

I really don't like the ideia of add the some code snipped on README. I
know it's very common and most libraries do this but, it's a lot of code to
explain in a README and 2 different places to update when we
change/improve/whatever our libraries. I really prefer link to the ag.org
doc.

In related news I'd like to add a link to a example app as we did[1] on
push library

[1] https://github.com/aerogear/aerogear-android-push#demo-apps

-- Passos


On Tue, Jan 27, 2015 at 11:47 AM, Lukáš Fryč <lukas.fryc at gmail.com> wrote:

> Yea, it would be nice if usage would show the code snippet, so Usage would
> cover:
>
> 1. how to add the library dependency to your project (which is covered in
> Android Core README)
> 2. a smallest possible snippet of the code that covers how to use the lib
> (that is not covered atm) + link to respective feature doc if needed
>
> I like what iOS has here [1], do we want to adopt this pattern for
> Android, Cordova and JS as well?
>
> [1] https://github.com/aerogear/aerogear-ios-oauth2
>
> On Tue, Jan 27, 2015 at 11:24 AM, Corinne Krych <corinnekrych at gmail.com>
> wrote:
>
>> it looks good, I’m just puzzled by the usage section in you gist:
>> https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b#usage
>> which contains more build instruction than usage of android-core…
>>
>> for our ios readme we have the same content, not foramtted the same way
>> though but it shoudn’t be a pb to reformat.
>>
>> ++
>> Corinne
>>
>> > On 27 Jan 2015, at 11:22, Sebastien Blanc <scm.blanc at gmail.com> wrote:
>> >
>> > sounds good !
>> >
>> > On Tue, Jan 27, 2015 at 11:19 AM, Lukáš Fryč <lukas.fryc at gmail.com>
>> wrote:
>> > Hey guys,
>> >
>> > me and passos brainstormed yesterday about the project info in the
>> README files
>> >
>> > as it would be nice to unify them across all repositories (discussed
>> elsewhere) and mainly allow people navigate from code repositories directly
>> to locations where they can find more help, etc.
>> >
>> >
>> > As a result, we both liked:
>> >
>> > 1. brief Project Info in the header
>> > 2. more verbose Documentation / Development / Questions? / Found a bug?
>> section in the footer
>> >
>> > Example for Android Core:
>> https://gist.github.com/lfryc/df0c9c9a9ba7acebfd7b
>> >
>> >
>> > Let me know what you think.
>> >
>> > If I don't get any -1, I will send pull requests with the updates in
>> all aerogear repositories at the end of this week.
>> >
>> >
>> > Cheers!
>> >
>> > ~ Lukas
>> >
>> >
>> > P.S.: aerogear-users has just a ordinary mailman archive while
>> aerogear-dev uses nabble, which is far better for navigation / search, etc.
>> (the request to add that feature to aerogear-users is tracked in
>> https://issues.jboss.org/browse/AEROGEAR-1590 )
>> >
>> > _______________________________________________
>> > aerogear-dev mailing list
>> > aerogear-dev at lists.jboss.org
>> > https://lists.jboss.org/mailman/listinfo/aerogear-dev
>> >
>> > _______________________________________________
>> > aerogear-dev mailing list
>> > aerogear-dev at lists.jboss.org
>> > https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>>
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>>
>
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/aerogear-dev/attachments/20150127/99f40d5f/attachment.html