|
2 | 2 |
|
3 | 3 | ## Description |
4 | 4 |
|
5 | | -Code Aggregator is a Windows Forms application that allows users to select folders and files within a directory structure and aggregate the contents of selected text files into a single output file. This application is useful for creating a consolidated file of all code or text within a solution folder. |
| 5 | +Code Aggregator is an application that allows you to select a root folder and aggregate all text files within the selected folder and its subfolders into a single text file. This is particularly useful for consolidating code files or other text-based files. |
6 | 6 |
|
7 | 7 | ## Features |
8 | 8 |
|
9 | | -- Select a root folder using a folder dialog. |
10 | | -- Display the folder structure in a tree view with checkboxes to include/exclude files and folders. |
11 | | -- Save and load inclusion/exclusion settings for each folder. |
12 | | -- Aggregate text contents from selected files into a single output file. |
13 | | -- Detect and exclude non-text files from aggregation. |
14 | | -- Display progress during the aggregation process. |
| 9 | +- Select a root folder for aggregation. |
| 10 | +- Include or exclude specific files and folders using checkboxes. |
| 11 | +- Save the aggregated text to a specified location. |
| 12 | +- Option to open the aggregated file after the operation completes. |
15 | 13 |
|
16 | | -## Requirements |
| 14 | +## How to Use |
17 | 15 |
|
18 | | -- .NET Framework 4.7.2 or later |
19 | | -- Windows OS |
| 16 | +1. Click the 'Select Folder' button to choose the root folder for aggregation. |
| 17 | +2. Use the checkboxes to include or exclude specific files and folders. By default, all folders and files are included. |
| 18 | +3. Click 'Start Operation' to begin the aggregation process. You will be prompted to specify the location and name of the output file. |
| 19 | +4. Note: It is recommended to exclude folders like .git, .vs, or other dependency folders to avoid including unnecessary files. |
20 | 20 |
|
21 | 21 | ## Installation |
22 | 22 |
|
23 | | -1. Clone the repository from GitHub: |
24 | | - ```bash |
25 | | - git clone https://github.com/your-username/code-aggregator.git |
| 23 | +### Prerequisites |
| 24 | + |
| 25 | +- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0) |
| 26 | + |
| 27 | +### Building the Executable |
| 28 | + |
| 29 | +1. Clone the repository: |
| 30 | + |
| 31 | + ```sh |
| 32 | + git clone https://github.com/yourusername/code-aggregator.git |
| 33 | + cd code-aggregator |
| 34 | + ``` |
| 35 | + |
| 36 | +2. Build the project: |
| 37 | + |
| 38 | + ```sh |
| 39 | + dotnet build --configuration Release |
26 | 40 | ``` |
27 | | -2. Open the solution in Visual Studio. |
28 | | -3. Build the solution to restore the NuGet packages and compile the project. |
29 | 41 |
|
30 | | -## Usage |
| 42 | +### Creating the Installer |
| 43 | + |
| 44 | +1. Ensure you have [Inno Setup](https://jrsoftware.org/isinfo.php) installed. |
| 45 | + |
| 46 | +2. Open the `Inno Install Compiler Script.iss` file in Inno Setup. |
| 47 | + |
| 48 | +3. Compile the script. This will look for the built executable in the `bin/Release/net8.0-windows` folder and create a `setup.exe` file in the `Output` folder. |
| 49 | + |
| 50 | +### Running the Installer |
| 51 | + |
| 52 | +1. Navigate to the `Output` folder where the `setup.exe` file was created. |
| 53 | + |
| 54 | +2. Run `setup.exe` to install the Code Aggregator application. |
31 | 55 |
|
32 | | -1. Run the application. |
33 | | -2. Select a root folder when prompted. |
34 | | -3. Use the tree view to select or deselect folders and files. |
35 | | -4. Click "Start Operation" to begin aggregating the text contents of the selected files. |
36 | | -5. Choose the location and name for the output file in the save file dialog. |
| 56 | +3. After installation, you can find the application in the Start Menu under "Code Aggregator." |
37 | 57 |
|
38 | 58 | ## Contributing |
39 | 59 |
|
40 | | -Contributions are welcome! Please fork the repository and create a pull request with your changes. |
| 60 | +Contributions are welcome! Please open an issue or submit a pull request for any changes. |
41 | 61 |
|
42 | 62 | ## License |
43 | 63 |
|
44 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 64 | +This project is licensed under the MIT License. |
0 commit comments