Commit 8fd5534c authored by Christopher Bohn's avatar Christopher Bohn 🤔
Browse files

Added instructions for using this project's code in another project

parent 558e80b5
......@@ -98,4 +98,24 @@ code that uses data from [OpenWeathermap.org](https://openweathermap.org).
- Three-hour rain (and three-hour snow) total defaults to the 1-hour rain (snow)
when a separate 3-hour value is not reported. Recent real-world data calls
into question the assumption that a 3-hour value will be reported when rain
has fallen for more than an hour (or even more than three hours)
\ No newline at end of file
has fallen for more than an hour (or even more than three hours)
### Use in Your Project
#### JavaDoc
You can generate the JavaDoc pages for publicly-accessible elements by invoking
the `javadoc:javadoc` Maven target from your IDE or from the command line:
```
mvn javadoc:javadoc
```
Open the file `target/site/apidocs/index.html` in your web browser to use the
JavaDoc pages.
#### Maven notes
If you copy the classes and interface from this project into your own, be sure
that:
- Your `pom.xml` file specifies Java version 11 or later
- Your `pom.xml` file includes a dependency for
[JSON.simple](https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple)
\ No newline at end of file
......@@ -29,7 +29,6 @@
<configuration>
<show>public</show>
<source>11</source>
<target>11</target>
</configuration>
</plugin>
</plugins>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment