diff --git a/.gitignore b/.gitignore index 96ef862..724f1ea 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ target/ .idea/ +.vscode/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..c5f3f6b --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "java.configuration.updateBuildConfiguration": "interactive" +} \ No newline at end of file diff --git a/README.md b/README.md index 2ec6fcf..02c322a 100644 --- a/README.md +++ b/README.md @@ -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} @@ -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. diff --git a/pom.xml b/pom.xml index 14fc2d7..4d06ec9 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ 4.0.0 - com.example + com.liningalex.rothoptimizer IRA2RothOptimizer 1.0-SNAPSHOT @@ -33,4 +33,60 @@ 3.17.0 + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.11.0 + + 17 + 17 + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.1.2 + + + **/*Test.java + + + + + org.apache.maven.plugins + maven-jar-plugin + 3.3.0 + + + + com.liningalex.rothoptimizer.IraRothPlanner + + + + + + org.apache.maven.plugins + maven-shade-plugin + 3.5.1 + + + package + + shade + + + false + + + com.liningalex.rothoptimizer.IraRothPlanner + + + + + + + + \ No newline at end of file