Skip to content

Commit

Permalink
Update readme and index page for docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
gbrail committed Oct 10, 2024
1 parent 0345853 commit cdf0067
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 7 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ features from ES6, and ES2016+ are implemented in Rhino.

## Documentation

[Rhino Documentation](./docs/index.md) is here on GitHub.

The most helpful docs are the [embedding guide](./docs/embedding.md) and the basics
of [how scopes and contexts work](./docs/scopes-and-contexts.md) (which are a little different from other JavaScript engines).

Information for script builders and embedders:

[Archived](http://web.archive.org/web/20210304081342/https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino/Documentation)
Expand Down Expand Up @@ -80,12 +85,19 @@ building with, you can test on another Java version using the RHINO_TEST_JAVA_VE

### How to Build

For normal development, you can build the code, run the static checks, and run all the tests like this:
For normal development on Linux or Mac, you can build the code, run the static checks,
and run all the tests like this. THe only prerequisite is to have Java in your path:

git submodule init
git submodule update
./gradlew check

On Windows the syntax is slightly different but not by much:

git submodule init
git submodule update
gradlew check

To just run the Rhino shell, you can do this from the top-level directory:

./gradlew run -q --console=plain
Expand Down Expand Up @@ -130,7 +142,7 @@ To see an aggregated coverage report for everything, which is probably what you
The result is in:
./tests/build/reports/jacoco/testCodeCoverageReport/html

## Releasing and publishing new version
## Releasing and publishing a new version

1. Ensure all tests are passing
2. Remove `-SNAPSHOT` from version in `gradle.properties` in project root folder
Expand Down
26 changes: 21 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,28 @@

Rhino is an implementation of JavaScript in Java.

## Links
## Documentation

### How to Embed Rhino

* [Embedding guide](./embedding.md)
* [Accessing Java from Rhino](./scripting.md)
* [Basics of scopes and contexts](./scopes-and-contexts.md)

[Readme](https://github.com/mozilla/rhino)
### Instructions on Rhino's Command-Line Tools

[Release Notes](https://github.com/mozilla/rhino/blob/master/RELEASE-NOTES.md)
* The [Rhino shell](./shell.md)
* The [command-line compiler](./compiler.md)
* The [Rhino debugger](./debugger.md)

[Compatibility Table](./compat/engines.html)
### Miscellaneous Docs

* [Optimization hints](./optimizations.md) (Very old, unfortunately, and not always relevant.)
* [Rhino history](./history.md)

## Links

[JavaDoc](https://javadoc.io/doc/org.mozilla/rhino)
* [Readme](https://github.com/mozilla/rhino)
* [Release Notes](https://github.com/mozilla/rhino/blob/master/RELEASE-NOTES.md)
* [Compatibility Table](./compat/engines.html)
* [JavaDoc](https://javadoc.io/doc/org.mozilla/rhino)

0 comments on commit cdf0067

Please sign in to comment.