Skip to content

Added maven compiler and made README clearer #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
WangRyan408 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added maven compiler and made README clearer #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f51765
Added maven compiler and made readme clearer
WangRyan408 Sep 25, 2025
2550427
Update .gitignore
WangRyan408 Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
target/
.idea/
.vscode/
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"java.configuration.updateBuildConfiguration": "interactive"
}
19 changes: 16 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,16 @@
- Flexible input: income, IRA balances, SSN income, estimate investment return etc.
- Long-term Roth IRA growth simulation

4. Usage:

4. Prerequisites:
- Java 17 SDK
- Maven

5. Usage:

Compile with `mvn clean package`

Run using the following commands:
```
IraRothPlanner
--ira={100000,180000}
--age={60,59}
Expand All @@ -29,8 +37,13 @@
--payTaxInIra=true
--investRtn=0.05
--yearBegin=2026
```
On windows:
```
java -jar .\IRA2RothOptimizer-1.0-SNAPSHOT.jar "--ira={100000,180000}" "--age={60,59}" --fixIncome=12000 "--ssnIncome={18000,28000}" --payTaxInIra=true --investRtn=0.05 --yearBegin=2026
```

7. Contributing:
5. Contributing:

Contributions are welcome!
Please open an issue or submit a pull request with improvements.
58 changes: 57 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<modelVersion>4.0.0</modelVersion>

<groupId>com.example</groupId>
<groupId>com.liningalex.rothoptimizer</groupId>
<artifactId>IRA2RothOptimizer</artifactId>
<version>1.0-SNAPSHOT</version>

Expand Down Expand Up @@ -33,4 +33,60 @@
<version>3.17.0</version> <!-- latest as of 2025 -->
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.11.0</version>
<configuration>
<source>17</source>
<target>17</target>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>3.1.2</version>
<configuration>
<includes>
<include>**/*Test.java</include>
</includes>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<configuration>
<archive>
<manifest>
<mainClass>com.liningalex.rothoptimizer.IraRothPlanner</mainClass>
</manifest>
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.5.1</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<createDependencyReducedPom>false</createDependencyReducedPom>
<transformers>
<transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
<mainClass>com.liningalex.rothoptimizer.IraRothPlanner</mainClass>
</transformer>
</transformers>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>