Skip to content
This repository was archived by the owner on Jul 1, 2024. It is now read-only.

Commit 5d57d00

Browse files
committed
README: Updated format and various wording
1 parent 28fa89f commit 5d57d00

File tree

1 file changed

+35
-36
lines changed

1 file changed

+35
-36
lines changed

README.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,40 @@
44
[![Build Status](https://img.shields.io/shippable/5840e5d8112fc80f00e0cb41/master.svg?colorA=9977bb&style=plastic)](https://app.shippable.com/projects/5840e5d8112fc80f00e0cb41/)
55
[![Code Quality](https://img.shields.io/coverity/scan/12326.svg?colorA=9977bb&style=plastic)](https://scan.coverity.com/projects/obsidian-studiosinc-jem)
66

7-
These are the release notes for jem. Read them carefully,
8-
as they tell you what this is all about, explain how to install jem,
9-
and what to do if something goes wrong.
7+
## About
108

11-
## WHAT IS JEM?
9+
jem is a Java Environment Manager, a re-write and port to C of a
10+
program on Gentoo Linux called
11+
[java-config](https://github.com/gentoo/java-config), written in
12+
python, specific to Gentoo Linux and derivatives. jem being in C, is
13+
Linux distro agnostic and should work for any POSIX compliant
14+
operating system. The intention is to standardize java management and
15+
tools for scripts and programs.
1216

13-
jem is a java environment manager, a re-write and port to C of
14-
a program on Gentoo Linux called java-config, written in python and
15-
specific to Gentoo Linux and derivatives. jem being in C, is Linux
16-
distro agnostic and should work for any POSIX compliant operating
17-
system. The intention is to standardize java management and tools for
18-
scripts and programs.
17+
jem provides means to manage and set system and user virtual machines
18+
independently. Along with ability to build package classpath and other
19+
things for a variety of uses. By using jem systems can have portable
20+
and consistent access to java virtual machines and packages.
1921

20-
jem provides means to manage and set system and user virtual machines
21-
independently. Along with ability to build package classpath and other
22-
things for a variety of uses. By using jem systems can have portable
23-
and consistent access to java virtual machines and packages.
22+
## Documentation:
2423

25-
## DOCUMENTATION:
24+
Documentation is generated from jem sources in the docs subdirectory
25+
after compiling jem. API documentation is created using doxygen and man
26+
page created from help2man. At some point a version will be placed
27+
online. For time being need to generation documentation yourself as
28+
needed. Or part of a system package.
2629

27-
Documentation is generated from jem sources in the docs subdirectory
28-
after compiling jem. API documentation is created using doxygen and
29-
man page created from help2man.
30+
## Download:
3031

31-
## DOWNLOAD:
32+
jem binaries and sources are currently available for download via
33+
[releases](https://github.com/Obsidian-StudiosInc/jem/releases).
3234

33-
jem binaries and sources are currently available for download at
34-
http://o-sinc.com/#/software/jem
35+
## Configuring:
3536

36-
## CONFIGURING:
37-
38-
In the root directory of the sources, run the following commands to
39-
configure cmake sources. cmake uses autotools by default. jem can be
40-
built with ninja instead of autotools for faster builds. Little chance
41-
of switching to meson build system.
37+
In the root directory of the sources, run the following commands to
38+
configure cmake sources. cmake uses autotools by default. jem can be
39+
built with ninja instead of autotools for faster builds. Little chance
40+
of switching to meson build system.
4241

4342
- To build jem with debugging symbols
4443

@@ -55,7 +54,7 @@ cmake -D CMAKE_BUILD_TYPE=Release ./
5554
- To build using ninja instead of autotools add -G Ninja to either
5655

5756

58-
## COMPILING:
57+
## Compiling:
5958
jem can be compiled via autotools or ninja
6059

6160
### Autotools
@@ -87,11 +86,11 @@ ninja
8786
ninja jem-test
8887
```
8988

90-
## INSTALLING:
89+
## Installing:
9190

92-
Installing jem should be done through the systems package manager. For
93-
integration with package managers and/or manual installation you can
94-
run the following command.
91+
Installing jem should be done through the systems package manager. For
92+
integration with package managers and/or manual installation you can
93+
run the following command.
9594

9695
### Autotools
9796
Install using autotools
@@ -105,11 +104,11 @@ Install using ninja
105104
ninja install
106105
```
107106

108-
## PACKAGING:
107+
## Packaging:
109108

110-
jem's build system can also build DEB, RPM, and TBZ2 packages for
111-
distribution. To build all the above targets (they cannot be build
112-
individually at this time) run the following command.
109+
jem's build system can also build DEB, RPM, and TBZ2 packages for
110+
distribution. To build all the above targets (they cannot be build
111+
individually at this time) run the following command.
113112

114113
### Autotools
115114
```

0 commit comments

Comments
 (0)