Skip to content

Commit be70b0f

Browse files
committed
Documentation edits
1 parent 5803f78 commit be70b0f

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ Elko is open source software, under the MIT license. See the file `LICENSE.md`
5454
## What's Here
5555

5656
* `Build` -- contains top level build files; however, you probably want the
57-
ones in `ServerCore/build` instead.
57+
ones in `ServerCore/build` instead (see the **Building** section immediately
58+
below).
5859

5960
* `ServerCore` -- contains the Elko server framework itself, along with its
6061
documentation.
@@ -72,9 +73,7 @@ Elko is open source software, under the MIT license. See the file `LICENSE.md`
7273
#### Building
7374

7475
To build the Java code from the sources directly as is, you will also need the
75-
[jdep](http://www.fudco.com/software/jdep.html) utility and GNU Make. Jdep is
76-
currently hosted on my own website, but I hope to have it moved to GitHub
77-
shortly. I'll update this page when that happens.
76+
[jdep](https://github.com/FUDCo/jdep) utility and GNU Make.
7877

7978
Note that most people doing Java development these days use one of the several
8079
popular Java IDEs and/or [Maven](https://maven.apache.org), but at the moment
@@ -97,17 +96,21 @@ More detail on building will be presented in an accompanying `BUILD.md` file
9796
once I get done writing it.
9897

9998
All the Java code works on any standard, reasonably current JVM, as it does not
100-
make use of any language features newer than generic. The various shell scripts
101-
in the `Run` tree do assume a Unix shell environment, but Cygwin will suffice
102-
and they are not deeply essential anyway.
99+
make use of any language features newer than generics. The various shell
100+
scripts in the `Run` tree do assume a Unix shell environment, but Cygwin will
101+
suffice and they are not deeply essential anyway.
103102

104103
#### Binaries
105104

106-
If you don't feel like building Elko yourself, a pre-built .jar file
107-
is available in the attached Release (v2.0.1).
105+
If you don't feel like building Elko yourself, a pre-built .jar file is
106+
available in the attached Release (v2.0.1).
108107

109108
#### Documentation
110109

111-
Currently, documentation is in the `ServerCore/doc` directory. Eventually
112-
these pages will be viewable here on GitHub. However, the JavaDoc files for
113-
the Elko classes are available [here](http://fudco.github.io/Elko/javadoc/).
110+
Detailed API and protocl documentation is sourced in the `ServerCore/doc`
111+
directory, but is viewable directly [here](http://fudco.github.io/Elko/). The
112+
*formatting* of what's there right now is a bit rough, not having entirely made
113+
the transition from its old home, but the content per se is as complete and up
114+
to date as ever. This will get prettier when I complete the migration to
115+
Jekyll.
116+

0 commit comments

Comments
 (0)