Add "How to Run" to README.md

[aravindharinair]

Hey, I was going through this and noticed that there is nothing mentioned as to how to run this application. For those who are new to Java or don't have much experience with Java, it will be a bit difficult as to find out how to run this. So, a small suggestion as given in the title.
Cheers!

[iamaamir]

thats good idea .. mean while there is a Netbeans project that i had added to repo that you can use build you jar if you are a NB user
https://github.com/sacert/SoundSea/tree/master/SoundSeaNBP

[aravindharinair]

Unfortunately I'm a user of Atom Text Editor and CMD... Hence my inability to run it... Any workarounds?

[kevinYangChengYi]

How to run soundsea to eclipse or Intellij? I use those only .....

[iamaamir]

@kevinYangChengYi the simple way is to create a blank project in ur IDE and put the SoundSea src into your project src... and done . i use this and it works..

[iamaamir]

@lord-frost then lets make use of cmd take all the src and compile them via cmd (assuming you know how to compile via cmd) and boom you are done...

[aravindharinair]

@iamaamir , you mean individually compile all the .java files in the src folder? Seriously?

[aravindharinair]

And I'm getting errors when compiling via javac...

[sligokid]

To run: download apache ant

$ cd SoundSeaNBP/
$ ant run
:)

[satishppawar]

While deploying the app I am getting an issue.

Please refer log

[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:93: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:129: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:179: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:190: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:202: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:215: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:243: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CDL.java:263: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\Cookie.java:79: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\Cookie.java:116: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CookieList.java:47: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\CookieList.java:68: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTP.java:56: error: semicolon missing
[javadoc] * Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTP.java:56: error: semicolon missing
[javadoc] * Cookie: Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTP.java:61: error: semicolon missing
[javadoc] * Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTP.java:61: error: semicolon missing
[javadoc] * Cookie: "Q=q2=PPEAsg--; B=677gi6ouf29bn&b=2&f=s",
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTP.java:69: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\HTTPTokener.java:46: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONTokener.java:228: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:261: warning: no @param for
[javadoc] public <E extends Enum> E getEnum(Class clazz, int index) throws JSONException {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:567: warning: no @param for
[javadoc] public <E extends Enum> E optEnum(Class clazz, int index) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:583: warning: no @param for
[javadoc] public <E extends Enum> E optEnum(Class clazz, int index, E defaultValue) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:1058: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:1074: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:1076: warning: no @param for writer
[javadoc] public Writer write(Writer writer) throws JSONException {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONArray.java:169: warning: no @param for array
[javadoc] public JSONArray(Object array) throws JSONException {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:245: error: bad use of '>'
[javadoc] * Comments, prologs, DTDs, and <[ [ ]]> are ignored.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:248: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:262: error: bad use of '>'
[javadoc] * Comments, prologs, DTDs, and <[ [ ]]> are ignored.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:265: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:280: error: bad use of '>'
[javadoc] * Comments, prologs, DTDs, and <[ [ ]]> are ignored.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:283: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:298: error: bad use of '>'
[javadoc] * Comments, prologs, DTDs, and <[ [ ]]> are ignored.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:301: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:312: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONML.java:396: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:487: warning: no @param for
[javadoc] public <E extends Enum> E getEnum(Class clazz, String key) throws JSONException {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:669: warning: no @param for jo
[javadoc] public static String[] getNames(JSONObject jo) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:689: warning: no @param for object
[javadoc] public static String[] getNames(Object object) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:874: warning: no @param for
[javadoc] public <E extends Enum> E optEnum(Class clazz, String key) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:890: warning: no @param for
[javadoc] public <E extends Enum> E optEnum(Class clazz, String key, E defaultValue) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1198: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1262: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1340: error: malformed HTML
[javadoc] * right places. A backslash will be inserted within </, producing </,
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1340: error: malformed HTML
[javadoc] * right places. A backslash will be inserted within </, producing </,
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1732: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONObject.java:1734: warning: no @param for writer
[javadoc] public Writer write(Writer writer) throws JSONException {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONWriter.java:290: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONWriter.java:310: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\JSONWriter.java:96: warning: no @param for w
[javadoc] public JSONWriter(Writer w) {
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\Property.java:41: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\Property.java:59: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:67: error: tag not allowed here:
[javadoc] * & (ampersand) is replaced by &amp;
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:68: error: tag not allowed here:
[javadoc] * < (less than) is replaced by &lt;
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:69: error: tag not allowed here:
[javadoc] * > (greater than) is replaced by &gt;
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:70: error: tag not allowed here:
[javadoc] * " (double quote) is replaced by &quot;
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:106: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:346: error: bad use of '>'
[javadoc] * <[ [ ]]> are ignored.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:349: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:365: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:377: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XML.java:49: error: bad use of '>'
[javadoc] /** The Character '>'. */
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:85: error: malformed HTML
[javadoc] * of tokens: the '<' character which begins a markup tag, and the content
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:88: error: malformed HTML
[javadoc] * @return A string, or a '<' Character, or null if there is no more
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:90: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:122: error: invalid entity '
[javadoc] * & ' > < ".
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:146: error: malformed HTML
[javadoc] * Returns the next XML meta token. This is used for skipping over <!...>
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:146: error: bad use of '>'
[javadoc] * Returns the next XML meta token. This is used for skipping over <!...>
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:147: error: malformed HTML
[javadoc] * and structures.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:147: error: bad use of '>'
[javadoc] * and structures.
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:148: error: malformed HTML
[javadoc] * @return Syntax characters (< > / = ! ?) are returned as
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:148: error: bad use of '>'
[javadoc] * @return Syntax characters (< > / = ! ?) are returned as
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:213: error: bad use of '>'
[javadoc] * brackets. It may be one of these characters: / > = ! ? or it
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:299: warning: no description for @throws
[javadoc] * @throws JSONException
[javadoc] ^
[javadoc] C:\Users\pawar\git\SoundSea\SoundSea\src\org\json\XMLTokener.java:301: warning: no @return
[javadoc] public boolean skipPast(String to) throws JSONException {
[javadoc] ^
[javadoc] Building index for all the packages and classes...
[javadoc] Building index for all classes...
[javadoc] Generating C:\Users\pawar\git\SoundSea\SoundSeaNBP\dist\javadoc\help-doc.html...
[javadoc] 26 errors

Does anyone help me?
I am also trying to understand the code.