Skip to content

Commit

Permalink
Preparing dist of 4.0
Browse files Browse the repository at this point in the history
- Update version to 4.0.0-SNAPSHOT
- Clean the README file
- Disable the prototype Python tools and associated doc
  • Loading branch information
rdeltour committed Aug 31, 2015
1 parent 35b84ee commit 2f6c719
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 16 deletions.
16 changes: 5 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
EpubCheck
=========

> *`master` branch status: epubcheck 4.0 pre-release in alpha stage* [![Build Status](https://travis-ci.org/IDPF/epubcheck.svg?branch=master)](https://travis-ci.org/IDPF/epubcheck/)
>
> *See bottom of the page for building or translating the 4.0 pre-release.*
----

EpubCheck is a tool to validate EPUB files. It can detect many
types of errors in EPUB. OCF container structure, OPF and OPS mark-up,
and internal reference consistency are checked. EpubCheck can be run
Expand All @@ -17,7 +11,7 @@ as a standalone command-line tool or used as a Java library.

Check the [release page](https://github.com/IDPF/epubcheck/releases) to get the latest distribution.

[EpubCheck 3.0.1](https://github.com/IDPF/epubcheck/releases/tag/v3.0.1) is the latest recommended version to validate both EPUB 2 and 3 files.
[EpubCheck 4.0](https://github.com/IDPF/epubcheck/releases/tag/v4.0) is the latest recommended version to validate both EPUB 2 and 3 files.


## Documentation
Expand Down Expand Up @@ -56,9 +50,9 @@ EpubCheck is made available under the terms of the [New BSD License](http://open

----

## Building the 4.0 pre-release
## Building EpubCheck

To build epubcheck from the sources you need Java Development Kit (JDK) 1.6 or above and [Apache Maven](http://maven.apache.org/) 2.3 or above installed.
To build epubcheck from the sources you need Java Development Kit (JDK) 1.7 or above and [Apache Maven](http://maven.apache.org/) 2.3 or above installed.
On Windows, you should build in a git bash shell (see http://github.com help)

You will also need Python to be able to run the BookReporter and related tools.
Expand All @@ -72,9 +66,9 @@ $ mvn install
Will copy `.*jar` files and packages to `target/` folder...


## Translating the 4.0 pre-release
## Translating EpubCjeck

epubcheck 4.0 now comes with *i18n* support. Feel free to translate the Java messsages file to your language and then open a Pull Request here.
EpubCheck 4.0 now comes with *i18n* support. Feel free to translate the Java messsages file to your language and then open a Pull Request here.

Translations so far:
* `en` - English
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

<groupId>org.idpf</groupId>
<artifactId>epubcheck</artifactId>
<version>4.0.0-alpha12-SNAPSHOT</version>
<version>4.0.0-SNAPSHOT</version>

<packaging>jar</packaging>

Expand Down
8 changes: 4 additions & 4 deletions src/main/assembly/dist.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,22 +29,22 @@
<include>*.txt</include>
</includes>
</fileSet>
<fileSet>
<!--<fileSet>
<outputDirectory>docs</outputDirectory>
<directory>docs</directory>
<includes>
<include>*.docx</include>
<include>*.pdf</include>
</includes>
</fileSet>
<fileSet>
</fileSet>-->
<!--<fileSet>
<outputDirectory></outputDirectory>
<directory>target</directory>
<includes>
<include>*.py</include>
<include>*.pdf</include>
</includes>
</fileSet>
</fileSet>-->
</fileSets>
<dependencySets>
<dependencySet>
Expand Down

0 comments on commit 2f6c719

Please sign in to comment.