https://github.com/osoco/readme-generator
A simple experiment to auto-generate the project's README file using metadata from sources of truth like Maven's POM file, Makefiles, etc.
https://github.com/osoco/readme-generator
Last synced: 3 months ago
JSON representation
A simple experiment to auto-generate the project's README file using metadata from sources of truth like Maven's POM file, Makefiles, etc.
- Host: GitHub
- URL: https://github.com/osoco/readme-generator
- Owner: osoco
- License: mit
- Created: 2019-11-27T11:29:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-12-11T17:26:43.000Z (over 6 years ago)
- Last Synced: 2025-03-05T17:28:03.255Z (over 1 year ago)
- Language: Smalltalk
- Size: 36.1 KB
- Stars: 2
- Watchers: 9
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README Generator
The 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.
This 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.
## Installation
You can install this tool evaluating the following expression in a Pharo image:
```Smalltalk
Metacello new
baseline: 'ReadmeGenerator';
repository: 'github://osoco/READMEGenerator/src';
load.
```
## Running with Docker
You can use the tool without installing software via the following its [Docker image](https://hub.docker.com/r/osoco/readme-generator).
Simply execute the following command from the project's root directory:
```
$ docker run -v $(pwd):/data osoco/readme-generator:latest [--help]
```
## Usage
The targets to build or run the application are defined via its [Makefile](Makefile):
```shell
Clean
-----
mrproper Delete all artefacts
Build
-------
build Build README Generator
get-image Download the latest stable Pharo image and VM
install Install README Generator and dependencies
Docker
------
build-docker Run all tests
Running
-------
run Run the generator
```
## Project Links
* Source Code: [GitHub](https://github.com/osoco/READMEGenerator)
## Team
* 
[Rafael Luque](https://osoco.es) (*Pharo Developer*)
## License
* MIT License