Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
114 lines (105 sloc) 2.72 KB

Usage

Create README configuration file

README.md generator needs a configuration file of your README, just create a file called readme.json in the root of your repository:

{
  "PROJECT": {
    "NAME": "",
    "ICON": {
      "IMAGE": "",
      "ALT": "",
      "WIDTH": 0,
      "HEIGHT": 0
    },
    "URL": "",
    "URL_TITLE": ""
  },
  "AUTHOR": {
    "NAME": "",
    "URL": "",
    "ALT": "",
    "DATE": "",
    "SECTION": {
      "TITLE": "Author",
      "SHOW": true
    }
  },
  "DESCRIPTION": "",
  "BADGES": {
    "0": {
      "IMAGE": "",
      "HREF": "",
      "ALT": ""
    },
    "1": {
      "IMAGE": "",
      "HREF": "",
      "ALT": ""
    },
    "2": {
      "NEWLINE": true
    },
    "3": {
      "IMAGE": "",
      "HREF": "",
      "ALT": ""
    }
  },
  "CONTENT": "readme.content.md"
}

In readme.content.md you can write the main content of your README, this has to be in the same root of your readme.json configuration.

Example of this README
{
  "PROJECT": {
    "NAME": "README.md Generator",
    "ICON": {
      "IMAGE": "icon.png",
      "ALT": "",
      "WIDTH": 200,
      "HEIGHT": 200
    },
    "URL": "http://ppizarror.com/readme-generator/",
    "URL_TITLE": "README.md Generator"
  },
  "AUTHOR": {
    "NAME": "Pablo Pizarro R.",
    "URL": "http://ppizarror.com",
    "ALT": "ppizarror",
    "DATE": "2017",
    "SECTION": {
      "TITLE": "Author",
      "SHOW": true
    }
  },
  "DESCRIPTION": "Generate a README.md file from a configuration file",
  "BADGES": {
    "0": {
      "IMAGE": "http://ppizarror.com/badges/author.svg",
      "HREF": "http://ppizarror.com",
      "ALT": "@ppizarror"
    },
    "1": {
      "IMAGE": "http://ppizarror.com/badges/licensemit.svg",
      "HREF": "https://opensource.org/licenses/MIT/",
      "ALT": "MIT License"
    },
    "2": {
      "IMAGE": "http://ppizarror.com/badges/python27.svg",
      "HREF": "https://www.python.org/downloads/",
      "ALT": "Python 2.7"
    }
  },
  "CONTENT": "readme.content.md"
}

Run README Generator

Just run this Python app, load your file and click on Generate README.md button to create your new README file. You can also push your new readme to your github account by clicking on the icon next to the button.

License

This project is under MIT License [https://opensource.org/licenses/MIT]