Skip to content

Commit

Permalink
Updates to add a section to the main landing page for the intro prese…
Browse files Browse the repository at this point in the history
…ntation
  • Loading branch information
tviegut committed May 2, 2024
1 parent 3ab7d82 commit 729a89c
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ In November of 2022, with Tanja Kostic's approval, jCleanCim was officially migr
This is a non-GUI Java application and the Java code is fully platform independent. However, it unfortunately must be run on MS Windows machine due to the usage of Enterprise Architect and MS Word automation libraries (.dlls).

* [Latest Release](#latest-release)
* [jCleanCim Presentation](#jcleancim-presentation)
* [Documentation](#documentation)
* [Which distribution should I download?](#which-distribution-should-i-download)
* [Dependencies](#dependencies)
Expand All @@ -30,10 +31,16 @@ For a full history of all release notes see [here](ReleaseNotes.md).
- The latest release is available on GitHub at [jCleanCim-2.3.0](https://github.com/cimug-org/jCleanCim/releases) and is delivered as a ZIP file.
- Information on features and fixes for the release can be found in the [release notes](ReleaseNotes.md).

## Introduction to jCleanCim

Check out the "Introduction to jCleanCim" presentation presentation. It is available in both PDF and PPT formats.

[![image](readme-icons/about-jcleancim.png)](doc/jCleanCimIntro.pdf)

## Documentation
Once you unzip a jCleanCim distribution, `doc` directory contains the full documentation. The important parts of the source code are documented and that documentation is generated as so-called _javadoc_ - namely, a set of web pages that allow for easy navigation.

* Each distribution contains an up to date set of slides `doc/jCleanCimIntro.pptx` - you may want to start from there.
* Each distribution contains an up to date set of slides `doc/jCleanCimIntro.pptx` (`doc/jCleanCimIntro.pdf`) - you may want to start from there.
* Each distribution contains the javadoc in `doc/api/index.html`. The documentation of the root package `org.tanjakostic.jcleancim` (Description section) is a good starting point.
* Binary distribution contains also the PDF version of that same javadoc, in a file `doc/jCleanCim-[_version_].pdf` (source distribution contains the Apache ant build script to produce this document, so it is not packaged in source distributions).
* Source distribution contains the PDF version of the depency graph of the Apache ant build targets (this is useful for a developer only).
Expand Down
Binary file removed about-jcleancim.png
Binary file not shown.
Binary file modified doc/jCleanCimIntro.pptx
Binary file not shown.
Binary file added readme-icons/about-jcleancim.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 729a89c

Please sign in to comment.