{"id":20490643,"url":"https://github.com/osoco/readme-generator","last_synced_at":"2026-03-10T00:33:57.817Z","repository":{"id":140853131,"uuid":"224415368","full_name":"osoco/readme-generator","owner":"osoco","description":"A simple experiment to auto-generate the project's README file using metadata from sources of truth like Maven's POM file, Makefiles, etc.","archived":false,"fork":false,"pushed_at":"2019-12-11T17:26:43.000Z","size":37,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-05T17:28:03.255Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Smalltalk","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osoco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-27T11:29:35.000Z","updated_at":"2019-12-14T19:38:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"be82450d-2fb8-4e0b-bac1-2dcab753765b","html_url":"https://github.com/osoco/readme-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osoco/readme-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osoco%2Freadme-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osoco%2Freadme-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osoco%2Freadme-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osoco%2Freadme-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osoco","download_url":"https://codeload.github.com/osoco/readme-generator/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osoco%2Freadme-generator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30318501,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T20:05:46.299Z","status":"ssl_error","status_checked_at":"2026-03-09T19:57:04.425Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T17:17:48.715Z","updated_at":"2026-03-10T00:33:57.795Z","avatar_url":"https://github.com/osoco.png","language":"Smalltalk","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# README Generator\n\n\n\nThe README Generator is a Pharo Smalltalk based tool to auto-generate a software project's README file using the metadata fetched from sources of truth like Maven's POM file and/or Makefiles.\n    \nThis way you avoid data repetition and inconsistencies in documentation. You should never edit manually your project's README, but regenerate it every time the project's metadata are updated.\n\n## Installation\n\nYou can install this tool evaluating the following expression in a Pharo image:\n\n```Smalltalk\nMetacello new\n    baseline: 'ReadmeGenerator';\n    repository: 'github://osoco/READMEGenerator/src';\n    load.\n```\n\n## Running with Docker\n\nYou can use the tool without installing software via the following its [Docker image](https://hub.docker.com/r/osoco/readme-generator).\n\nSimply execute the following command from the project's root directory:\n\n```\n$ docker run -v $(pwd):/data osoco/readme-generator:latest [--help]\n```\n\n  \n\n\n\n## Usage\n\nThe targets to build or run the application are defined via its [Makefile](Makefile):\n\n```shell\n                           \nClean                      \n-----                      \nmrproper                      Delete all artefacts\n                           \nBuild                      \n-------                    \nbuild                         Build README Generator\nget-image                     Download the latest stable Pharo image and VM\ninstall                       Install README Generator and dependencies\n                           \nDocker                     \n------                     \nbuild-docker                  Run all tests\n                           \nRunning                    \n-------                    \nrun                           Run the generator\n\n```\n\n\n\n## Project Links\n\n* Source Code: [GitHub](https://github.com/osoco/READMEGenerator)\n\n## Team\n\n\n* \u003cimg src=\"https://osoco.es/images/personas/rafael-luque.jpg\" height=\"30\"\u003e [Rafael Luque](https://osoco.es) (*Pharo Developer*)\n\n\n## License\n\n* MIT License\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosoco%2Freadme-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosoco%2Freadme-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosoco%2Freadme-generator/lists"}