Skip to content

Commit 12b46f5

Browse files
authored
Update README.md
1 parent 3f665f7 commit 12b46f5

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

+19-25
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This feature provides a hands-on approach to work with ASMs, enabling users to m
3838

3939
## How to Start:
4040

41-
### Cloning the Repository
41+
### Using Maven
4242
1. Open PowerShell or your preferred terminal and clone the repository:
4343
```shell
4444
git clone https://github.com/isaacmaffeis/asmetal2java.git
@@ -49,8 +49,6 @@ This feature provides a hands-on approach to work with ASMs, enabling users to m
4949
cd ./asmetal2java
5050
```
5151

52-
### Using Maven
53-
5452
3. Install the project and generate the executable JAR:
5553
```shell
5654
mvn clean install
@@ -87,28 +85,29 @@ This feature provides a hands-on approach to work with ASMs, enabling users to m
8785

8886
### Using Docker
8987

90-
3. Open Docker Desktop and build the Docker image:
88+
1. Open Docker Desktop and pull the Docker image:
9189
```shell
92-
docker build -t asmetal2java_codegen .
90+
docker pull isaacmaffeis/asmetal2java_codegen:latest
9391
```
9492

95-
4. Run the application within a Docker container:
93+
2. Run the application (print the help message) within a Docker container:
9694
```shell
97-
docker run --rm asmetal2java_codegen
95+
docker run --rm isaacmaffeis/asmetal2java_codegen
9896
```
9997

100-
5. Customize execution by passing options:
98+
3. Mount the volumes and run:
10199
```shell
102-
docker run --rm -v "$(pwd)/<input>:/app/<input>" -v "$(pwd)/asmetal2java_codegen/<output>:/app/asmetal2java_codegen/<output>" asmetal2java_codegen -input <input> -output <output> -D<property=value>
100+
docker run --rm -v "$(pwd)/<input>:/app/<input>" -v "$(pwd)/<output>:/app/<output>" isaacmaffeis/asmetal2java_codegen -input <input> -output <output> -D<property=value>
103101
```
104102

105103
- `-v "$(pwd)/<input>:/app/<input>"` : Maps the input file from the host to the container (required)
106104

107105
- `-v "$(pwd)/<output>:/app/<output>"` : Maps the output folder from the host to the container (required, use `<output>` as `output` for the default path)
108106

109-
6. Example of a use case:
107+
4. Example of a use case:
108+
Inside the root directory `./amsetal2java/` run:
110109
```shell
111-
docker run --rm -v "$(pwd)/asmetal2java_codegen/examples:/app/asmetal2java_codegen/examples" -v "$(pwd)/asmetal2java_codegen/output:/app/output" asmetal2java_codegen -input "examples/RegistroDiCassa.asm" -output "output"
110+
docker run --rm -v "$(pwd)/asmetal2java_codegen/examples:/app/input" -v "$(pwd)/asmetal2java_codegen/output:/app/output" isaacmaffeis/asmetal2java_codegen -input "input/RegistroDiCassa.asm" -output "output"
112111
```
113112
# Asmetal2java_asmgen
114113

@@ -167,32 +166,27 @@ the _ASM class produced by asmetal2java_asmgen is designed for automated process
167166

168167
### Using Docker
169168

170-
3. Open Docker Desktop and build the Docker image:
169+
1. Open Docker Desktop and pull the Docker image:
171170
```shell
172-
docker build -t asmetal2java_asmgen .
171+
docker pull isaacmaffeis/asmetal2java_asmgen:latest
173172
```
174173

175-
4. Run the application within a Docker container:
174+
2. Run the application (print the help message) within a Docker container:
176175
```shell
177-
docker run --rm asmetal2java_asmgen
176+
docker run --rm isaacmaffeis/asmetal2java_asmgen
178177
```
179178

180-
5. Customize execution by passing options:
179+
3. Mount the volumes and run:
181180
```shell
182-
docker run --rm -v "$(pwd)/<input>:/app/<input>" -v "$(pwd)/asmetal2java_asmgen/<output>:/app/asmetal2java_asmgen/<output>" asmetal2java_asmgen -input <input> -output <output> -D<property=value>
181+
docker run --rm -v "$(pwd)/<input>:/app/<input>" -v "$(pwd)/<output>:/app/<output>" isaacmaffeis/asmetal2java_asmgen -input <input> -output <output> -D<property=value>
183182
```
184183

185184
- `-v "$(pwd)/<input>:/app/<input>"` : Maps the input file from the host to the container (required)
186185

187186
- `-v "$(pwd)/<output>:/app/<output>"` : Maps the output folder from the host to the container (required, use `<output>` as `output` for the default path)
188187

189-
- `-input` : The ASM input file (required)
190-
191-
- `-output` : Output folder (optional, defaults to `./output/`)
192-
193-
- `-D <property=value>` : Additional properties (optional, see `-help` for more info)
194-
195-
6. Example of a use case:
188+
4. Example of a use case:
189+
Inside the root directory `./amsetal2java/` run:
196190
```shell
197-
docker run --rm -v "$(pwd)/asmetal2java_asmgen/examples:/app/asmetal2java_asmgen/examples" -v "$(pwd)/asmetal2java_asmgen/output:/app/output" asmetal2java_asmgen -input "examples/RegistroDiCassav4.asm" -output "output"
191+
docker run --rm -v "$(pwd)/asmetal2java_asmgen/examples:/app/input" -v "$(pwd)/asmetal2java_asmgen/output:/app/output" isaacmaffeis/asmetal2java_asmgen -input "input/RegistroDiCassav4.asm" -output "output"
198192
```

0 commit comments

Comments
 (0)