|
1 | 1 | ## java2python Documentation |
2 | 2 |
|
3 | | -Please read the |
4 | | -[introduction](https://github.com/natural/java2python/tree/master/doc/intro.md) |
5 | | -for information about what the package does, how it works, and why it was |
6 | | -created. From there you should proceed to the |
7 | | -[usage](https://github.com/natural/java2python/tree/master/doc/usage.md) page |
8 | | -for an overview of how to work with the tool. When you really get going, |
9 | | -you'll want to read the |
10 | | -[features](https://github.com/natural/java2python/tree/master/doc/features.md) |
11 | | -page to learn what you can do. |
12 | | - |
13 | | - |
14 | | -### Contents |
15 | | - |
16 | | -These are the docs we've got: |
17 | | - |
18 | | -* [Introduction](https://github.com/natural/java2python/tree/master/doc/intro.md) |
19 | | -* [Installation](https://github.com/natural/java2python/tree/master/doc/install.md) |
20 | | -* [Features](https://github.com/natural/java2python/tree/master/doc/features.md) |
21 | | -* [Usage](https://github.com/natural/java2python/tree/master/doc/usage.md) |
22 | | -* [Customization](https://github.com/natural/java2python/tree/master/doc/customization.md) |
| 3 | +#### Introduction |
| 4 | + |
| 5 | +The [Introduction][] provides a brief overview of the package. You should read |
| 6 | +this first. |
| 7 | + |
| 8 | +#### Installation |
| 9 | + |
| 10 | +The [Installation][] doc describes how to install the package. |
| 11 | + |
| 12 | +#### Translation Features |
| 13 | + |
| 14 | +The [Translation Features][] page documents how the package translates Java |
| 15 | +syntax to Python |
| 16 | + |
| 17 | +#### Usage |
| 18 | +The [Usage][] page explains how to run the `j2py` script. |
| 19 | + |
| 20 | + |
| 21 | +#### Customization |
| 22 | +The [Customization][] doc describes how to customize translation behavior. |
| 23 | + |
| 24 | + |
| 25 | +[Customization]: https://github.com/natural/java2python/tree/master/doc/customization.md |
| 26 | +[Installation]: https://github.com/natural/java2python/tree/master/doc/install.md |
| 27 | +[Introduction]: https://github.com/natural/java2python/tree/master/doc/intro.md |
| 28 | +[Translation Features]: https://github.com/natural/java2python/tree/master/doc/features.md |
| 29 | +[Usage]: https://github.com/natural/java2python/tree/master/doc/usage.md |
0 commit comments