Skip to content

Commit

Permalink
docs: Added extra clarification in "How To Use" section in README
Browse files Browse the repository at this point in the history
Added required OS and clarified that an Internet connection is needed in the release notes generated from merge commits.
  • Loading branch information
Ahmed-Khaled-dev authored Mar 6, 2024
1 parent fee58b5 commit c9cdc34
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
<img src="https://i.imgur.com/Z8LRRgz.png" alt="Automated release notes generator">

## How To Use
**Required Operating System:** Windows

To use this script you'll need <a href="https://git-scm.com/" target="_blank">Git</a> installed on your computer

1. Download the <a href="https://drive.google.com/drive/folders/1ustJy8Znff_TrAfIbGwQJpSmiq4ULA_h?usp=sharing" target="_blank">executable and dlls</a>
Expand All @@ -52,15 +54,15 @@ To use this script you'll need <a href="https://git-scm.com/" target="_blank">Gi
```
$ release_notes_generator n
```
2. Generate **short** release notes from **merge commits**
2. Generate **short** release notes from **merge commits** (Internet connection required)
```
$ release_notes_generator m s
```
3. Generate **full** release notes from **merge commits**
3. Generate **full** release notes from **merge commits** (Internet connection required)
```
$ release_notes_generator m f
```

## Notes
- The current prototype displays a maximum of 3 release notes for each commit type section to prevent excessive markdown output in large repositories like Synfig's. Future iterations may include options to customize this limit via an external configuration file or through user input or based on the date of the last commit or git tags, etc.
- The current prototype demonstrates the display of three common commit types (fix, feat, and refactor). later on these can be modified very easily
- The current prototype demonstrates the display of three common commit types (fix, feat, and refactor). later on these can be modified very easily

0 comments on commit c9cdc34

Please sign in to comment.