From e41cbbc0890f4491d924c3ad1736bb7b24be9115 Mon Sep 17 00:00:00 2001 From: Louan Fontenele Date: Sun, 29 Dec 2024 09:09:47 -0300 Subject: [PATCH] Fix: Ignore README.md in all cases --- README.md | 91 ------------------------------------------------------- 1 file changed, 91 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 12363de..0000000 --- a/README.md +++ /dev/null @@ -1,91 +0,0 @@ -# 🚀 FactorioSaveGameEnableAchievements - -This project is a console application that modifies Factorio save files to re-enable achievements disabled by commands or map editor. - ---- - -## ✨ Features -- 🧐 Automatically extracts save files. -- 🔍 Modifies data to re-enable achievements. -- 🗂 Backs up the original save file. -- đŸ“Ļ Recompresses the save file with a versioned zip. - ---- - -## 🗃ī¸ Requirements -- .NET 8.0 SDK -- Visual Studio or compatible C# IDE -- Factorio save files (.zip format) - ---- - -## 🧑‍đŸ’ģ How to Compile and Run -### 1. Clone the Repository -```bash -git clone https://github.com/louanfontenele/FactorioSaveGameEnableAchievements -cd FactorioSaveGameEnableAchievements -``` - -### 2. Build the Project -```bash -dotnet build -``` - -### 3. Run the Program -```bash -dotnet run -``` - -Alternatively, open the solution file in Visual Studio. - ---- - -## 🕹ī¸ How to Use -1. Run the application. -2. Enter the path to the save file (e.g., `%appdata%\Factorio\saves\mysave.zip`). -3. The program modifies the save and creates a backup with `.bak`. - ---- - -## 📊 Automated Release Process -- **Changelog Generation**: A changelog is automatically created with each release. -- **Versioning**: Semantic versioning is used (). -- **Release Output**: The zip follows the format: -``` -FactorioSaveGameEnableAchievements-.zip -``` - ---- - -### 🔧 Commit Format (For Changelog) -Use the following format to categorize commits: - -```bash -git commit -m "Feature: Add new mechanic" -git commit -m "Fix: Resolve save crash" -git commit -m "Update: Improve save structure" -git commit -m "Remove: Remove deprecated feature" -``` - ---- - -## đŸ“Ļ Full Changelog -Check the **[Releases Section](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/releases)**. -Compare full changes **[here](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/compare)**. - ---- - -## 📊 Status -[![Release Status](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/actions/workflows/release-windows-dotnet.yml/badge.svg)](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/actions/workflows/release-windows-dotnet.yml) - ---- - -## 📝 Notes -- Ensure the save file is not in use by Factorio. -- This tool modifies saves that disable achievements. - ---- - -## 📩 Contact -For questions, open an **[issue](https://github.com/louanfontenele/FactorioSaveGameEnableAchievements/issues)** or contact directly via GitHub. -