Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KaiserDMC committed May 14, 2024
1 parent 1c7a380 commit f45c7ae
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,23 @@
By default the script is set to use Windows' built-in tools and it will create the archive in the same directory as the project.
If an archive with the same name already exists in the folder, it will be overwritten.

### How to use
The Linux version of this tool uses only standard tools that should be available in every distribution. It will once again use
the same directory as the project for the output of the `.zip` unless otherwise specified inside of the script.
Old archives are also overwritten.

### How to use (Windows)
All you need to do is run the ".bat" file and once asked paste the path of the project in the command pannel.
You should give the main path that you wish to archive, for example:

![path example](~/img/copy-path.png)
![path example](/img/copy-path.png)

Once you have done that paste it in the cmd window, like this:

![paste example](~/img/paste-path.png)
![paste example](/img/paste-path.png)

Press `Enter` and wait for the script to execute! Once its done you can close the cmd window.

### Linux Support
### How to use (Linux)
All you need to do is run the ".sh" file and once asked paste the path of the project in the terminal.
You can run the file by typing the following command inside of the terminal:
```bash
Expand All @@ -28,11 +32,11 @@ You can run the file by typing the following command inside of the terminal:

You should give the main path that you wish to archive, for example:

![path example](~/img/copy-path.png)
![path example](/img/copy-path.png)

Once you have done that paste it in the terminal window, like this:

![paste example](~/img/paste-path.png)
![paste example](/img/paste-path.png)

Press `Enter` and wait for the script to execute! Once its done you can close the terminal window.

Expand Down

0 comments on commit f45c7ae

Please sign in to comment.