search

andreimoment / tangomanual

An Open Source Approach to learning and teaching Tango based on curriculum developed by Mitra Martin
http://tangomanual.com/v1
2 stars 5 forks source link

README discussion (this is info for teachers and curriculum designers) #15

Open andreimoment opened 7 years ago

andreimoment commented 7 years ago

@mitramartin here are a few things I'd like to include in the README. Let's discuss.

  1. Licensing. Is this going to be under open source license? I feel yes, I recommend the mit license which allows free distribution. https://github.com/angular/angular.js/blob/master/LICENSE
  2. What is the recommended use of the manual? Purpose? Efforts behind it?
  3. A mention of P2P learning
  4. Possible link to lulu? Explain how the journal is useful?
  5. Instructions for contributing (in progress)
mitramartin commented 7 years ago

@andreimoment - where does the README appear? will people see it first, before they see the manual? is it at the top of the page? is it possible to include images? where can i edit it?

andreimoment commented 7 years ago

Appears as the homepage of the github project. You can edit it by editing readme.md On Thu, Apr 27, 2017 at 9:04 AM Mitra Martin notifications@github.com wrote:

@andreimoment https://github.com/andreimoment - where does the README appear? will people see it first, before they see the manual? is it at the top of the page? is it possible to include images? where can i edit it?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/andreimoment/tangomanual/issues/15#issuecomment-297759969, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAYLt68Xh72pm53_D8u6ckYJq8EjmQEks5r0Lx3gaJpZM4NGr1D .

andreimoment commented 7 years ago

Yes you can add images. See the markdown link in the README. On Thu, Apr 27, 2017 at 9:51 AM Andre aaandre@gmail.com wrote:

Appears as the homepage of the github project. You can edit it by editing readme.md On Thu, Apr 27, 2017 at 9:04 AM Mitra Martin notifications@github.com wrote:

@andreimoment https://github.com/andreimoment - where does the README appear? will people see it first, before they see the manual? is it at the top of the page? is it possible to include images? where can i edit it?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/andreimoment/tangomanual/issues/15#issuecomment-297759969, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAYLt68Xh72pm53_D8u6ckYJq8EjmQEks5r0Lx3gaJpZM4NGr1D .

mitramartin commented 7 years ago

@andreimoment will it also appear on the tangomanual website?

andreimoment commented 7 years ago

No, this is the readme/introductory file for the tangomanual repository, as seen on the repository home page: https://github.com/andreimoment/tangomanual (scroll down)

Sounds like you'd like to have a site description on tangomanual.com.

The content of the manual is at tangomanual.com/v1 so technically we could have an introductory page at tangomanual.com.

To create that, edit https://github.com/andreimoment/tangomanual/blob/master/index.md