Skip to content

Commit 8d4d8ab

Browse files
committed
Update readme
1 parent 815a92a commit 8d4d8ab

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
#Newton-Raphson Approximation Program
2+
[![Build Status](https://travis-ci.org/MathBunny/newton-raphson.svg?branch=master)](https://travis-ci.org/MathBunny/
3+
newton-raphson)
4+
![Issue Tracker](https://img.shields.io/github/issues/MathBunny/newton-raphson.svg)
5+
[![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg?maxAge=2592000)]()
26

3-
##Purpose
7+
##Purpose:
48
The purpose of this program is to find the root for _any_ expression using Newton's method. Provided any random point, this program can determine a root of the expression.
59

610
It's important to note that:
711
> Newton's method does not work if the slope of tangency is zero at the guess, nor does it identify multiple roots
812
9-
##Features
13+
##Features:
1014
* Nice interface to input equation
1115
* All input is error trapped right when entered by the user
1216
* User's estimate is error-trapped to prevent guessing when the tangent is equal to zero
@@ -16,8 +20,8 @@ It's important to note that:
1620
* JUnit tests
1721
* Ability to run in a console window
1822

19-
##How to Run & Documentation
20-
Simply compile the classes and run the `NewtonRaphsonApp.java`, and the program will run. Find JavaDoc documentation in the `doc/` folder. If you are interested in running this app through a command-line interface, run `NewtonRaphsonConsole.java` instead.
23+
##How to Run & Documentation:
24+
You can use ANT to build this project, or you can manually compile all the Java files. If you are interested in running this app through a command-line interface, run `NewtonRaphsonConsole.java`, or GUI `NewtonRaphsonApp.java`. Documentation can be found in the `/doc/` folder.
2125

2226
##Screenshot
2327
![Screenshot](http://horatiulazu.ca/software/images/NewtonRaphson.png "Screenshot")

0 commit comments

Comments
 (0)