Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
louanfontenele authored Dec 29, 2024
1 parent 455821a commit b9503bc
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This project is a console application that modifies Factorio save files to re-en
- 🔍 Locates and modifies the necessary data to re-enable achievements.
- 🗂️ Creates a backup of the original save file.
- 📦 Recompresses and restores the save file.
- 🔄 Automated GitHub Releases with changelogs generated from commits and PRs.

## 📋 Requirements

Expand Down Expand Up @@ -38,6 +39,28 @@ dotnet run

Alternatively, you can open the `.sln` file in Visual Studio and run the project using the built-in debugger.

## 🚀 Automated Release Workflow

This project uses **GitHub Actions** to automate the release process.

### How it Works
- **Triggers**: A new release is automatically created when a tag is pushed (e.g., `v1.0.0`).
- **Draft Releases**: The changelog is generated dynamically from PRs and commits.
- **Manual Trigger**: Releases can also be triggered manually from the Actions tab.

### Key Files:
- `.github/workflows/release-windows-dotnet.yml` – Workflow to build and release .NET projects.
- `.github/release-drafter.yml` – Template for changelog generation.

### Create a Tag to Trigger a Release:
```bash
git tag v1.0.0
git push origin v1.0.0
```

### Manual Release:
Go to **Actions** → Select the workflow → **Run Workflow**.

## 🕹️ How to Use

1. Run the application.
Expand All @@ -53,6 +76,8 @@ FactorioSaveGameEnableAchievements/
├── FactorioSaveGameEnableAchievements.sln # Solution file
├── Program.cs # Main application logic
├── FileProcessor.cs # Handles ZLib compression and decompression
├── .github/workflows/release-windows-dotnet.yml # GitHub Actions workflow for releases
├── .github/release-drafter.yml # Release drafter configuration
└── README.md # Project documentation
```

Expand All @@ -73,3 +98,4 @@ BSD 2-Clause License
## 🤝 Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss the changes you would like to make.

0 comments on commit b9503bc

Please sign in to comment.