@@ -38,7 +38,7 @@ This feature provides a hands-on approach to work with ASMs, enabling users to m
38
38
39
39
## How to Start:
40
40
41
- ### Cloning the Repository
41
+ ### Using Maven
42
42
1 . Open PowerShell or your preferred terminal and clone the repository:
43
43
``` shell
44
44
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
49
49
cd ./asmetal2java
50
50
` ` `
51
51
52
- # ## Using Maven
53
-
54
52
3. Install the project and generate the executable JAR:
55
53
` ` ` shell
56
54
mvn clean install
@@ -87,28 +85,29 @@ This feature provides a hands-on approach to work with ASMs, enabling users to m
87
85
88
86
# ## Using Docker
89
87
90
- 3 . Open Docker Desktop and build the Docker image:
88
+ 1 . Open Docker Desktop and pull the Docker image:
91
89
` ` ` shell
92
- docker build -t asmetal2java_codegen .
90
+ docker pull isaacmaffeis/ asmetal2java_codegen:latest
93
91
` ` `
94
92
95
- 4 . Run the application within a Docker container:
93
+ 2 . Run the application (print the help message) within a Docker container:
96
94
` ` ` shell
97
- docker run --rm asmetal2java_codegen
95
+ docker run --rm isaacmaffeis/ asmetal2java_codegen
98
96
` ` `
99
97
100
- 5. Customize execution by passing options :
98
+ 3. Mount the volumes and run :
101
99
` ` ` 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>
103
101
` ` `
104
102
105
103
- ` -v " $( pwd) /<input>:/app/<input>" ` : Maps the input file from the host to the container (required)
106
104
107
105
- ` -v " $( pwd) /<output>:/app/<output>" ` : Maps the output folder from the host to the container (required, use ` < output> ` as ` output` for the default path)
108
106
109
- 6. Example of a use case:
107
+ 4. Example of a use case:
108
+ Inside the root directory ` ./amsetal2java/` run:
110
109
` ` ` 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"
112
111
` ` `
113
112
# Asmetal2java_asmgen
114
113
@@ -167,32 +166,27 @@ the _ASM class produced by asmetal2java_asmgen is designed for automated process
167
166
168
167
# ## Using Docker
169
168
170
- 3 . Open Docker Desktop and build the Docker image:
169
+ 1 . Open Docker Desktop and pull the Docker image:
171
170
` ` ` shell
172
- docker build -t asmetal2java_asmgen .
171
+ docker pull isaacmaffeis/ asmetal2java_asmgen:latest
173
172
` ` `
174
173
175
- 4 . Run the application within a Docker container:
174
+ 2 . Run the application (print the help message) within a Docker container:
176
175
` ` ` shell
177
- docker run --rm asmetal2java_asmgen
176
+ docker run --rm isaacmaffeis/ asmetal2java_asmgen
178
177
` ` `
179
178
180
- 5. Customize execution by passing options :
179
+ 3. Mount the volumes and run :
181
180
` ` ` 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>
183
182
` ` `
184
183
185
184
- ` -v " $( pwd) /<input>:/app/<input>" ` : Maps the input file from the host to the container (required)
186
185
187
186
- ` -v " $( pwd) /<output>:/app/<output>" ` : Maps the output folder from the host to the container (required, use ` < output> ` as ` output` for the default path)
188
187
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:
196
190
` ` ` 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"
198
192
` ` `
0 commit comments