Update the README.md README.txt to follow README template to be ported to Drupal 8.

CommentFileSizeAuthor
#7 2839674-7.patch2.03 KBThew
#3 2839674-3.patch1.71 KBThew
#2 2839674-2.patch1.47 KBThew

Comments

Thew created an issue. See original summary.

Thew’s picture

Thew commented
Status: Active » Needs review
StatusFileSize
new 2839674-2.patch1.47 KB

My patch file.

Thew’s picture

Thew commented
StatusFileSize
new 2839674-3.patch1.71 KB

Updated patch.

Thew’s picture

Thew commented

Updated Patch in comment #3

gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Needs work

Thanks for the patch

  1. +++ b/README.md
@@ -0,0 +1,37 @@
+This project is part of the [Drupal Social Initiative](https://groups.drupal.org/social-initiative).  ¶

    There's an extra space in this line 

  2. +++ b/README.md
@@ -0,0 +1,37 @@
+ * Install as you would normally install a contributed Drupal module. See:
+   https://drupal.org/documentation/install/modules-themes/modules-7
+   for further information.

    Wrong link 

  3. +++ b/README.md
@@ -0,0 +1,37 @@
+CONFIGURATION
+-------------
+
+@TODO
+

    Maybe explain that users should download implementer modules and configure them. Also, you can describe how to add a Social Auth Login block 

  4. +++ b/README.md
@@ -0,0 +1,37 @@
+MAINTAINERS
+-----------
+
+@TODO

    As of current, just me. Please, also give credits to Google Summer of Code for the fund to create this project https://www.drupal.org/google-summer-of-code-0

gvso’s picture

gvso
Primary language Spanish
commented

I forgot to mention that the file should have the .txt extension. Therefore, you should not use markdowns

Thew’s picture

Thew commented
Title: Update README.md to the newest README template » Update README.txt to the newest README template
Issue summary: View changes
Status: Needs work » Needs review
StatusFileSize
new 2839674-7.patch2.03 KB
  • Remove markdown format and rename file to README.txt
  • Add configuration contents
  • Add maintainer and supporting organization
  • Update installation link

  • gvso committed 1cb4723 on 8.x-1.x authored by Thew 
    Issue #2839674 by Thew: Update README.txt
gvso’s picture

gvso
Primary language Spanish
commented
Status: Needs review » Fixed
gvso’s picture

gvso
Primary language Spanish
commented
Issue tags: +GCI16

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.