Skip to content

Commit

Permalink
Fix markdownlint warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
kaklakariada committed Apr 8, 2018
1 parent 930ec2c commit 044dab5
Show file tree
Hide file tree
Showing 4 changed files with 209 additions and 198 deletions.
8 changes: 8 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"default": true,
"no-inline-html": false,
"line-length": false,
"blanks-around-headers": false,
"no-trailing-punctuation": false,
"no-duplicate-header": false
}
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Sonarcloud Quality Gate](https://sonarcloud.io/api/badges/gate?key=org.itsallcode%3Aopenfasttrace%3Adevelop)](https://sonarcloud.io/dashboard?id=org.itsallcode%3Aopenfasttrace%3Adevelop)
[![codecov](https://codecov.io/gh/itsallcode/openfasttrace/branch/develop/graph/badge.svg)](https://codecov.io/gh/itsallcode/openfasttrace)
[![Coverity Scan Build Status](https://scan.coverity.com/projects/14936/badge.svg)](https://scan.coverity.com/projects/itsallcode-openfasttrace)
[![Download](https://api.bintray.com/packages/itsallcode/itsallcode/openfasttrace/images/download.svg) ](https://bintray.com/itsallcode/itsallcode/openfasttrace/_latestVersion)
[![Download](https://api.bintray.com/packages/itsallcode/itsallcode/openfasttrace/images/download.svg)](https://bintray.com/itsallcode/itsallcode/openfasttrace/_latestVersion)

## Installation

Expand All @@ -29,7 +29,7 @@ If you want to build OFT:

### Build Time Dependencies

The list below show all build time dependencies in alphabetical order. Note that except the Maven build tool all required modules are downloaded automatically by Maven.
The list below show all build time dependencies in alphabetical order. Note that except the Maven build tool all required modules are downloaded automatically by Maven.

| Dependency | Purpose | License |
-------------------------------------------------------------------------------|--------------------------------------------------------|--------------------------------
Expand All @@ -48,14 +48,16 @@ The list below show all build time dependencies in alphabetical order. Note that
### Configure Logging

We use [`java.util.logging`](https://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html) for logging. To configure log level and formatting, add the following system property:
```

```bash
-Djava.util.logging.config.file=src/test/resources/logging.properties
```

### License File Header

* We use [license-maven-plugin](http://www.mojohaus.org/license-maven-plugin) to check in `verify` phase that all files have the correct license header. The build will fail if there are any files with missing/outdated headers.
* To update files with correct license headers and generate file `LICENSE.txt`, run command

```bash
mvn license:update-project-license license:update-file-header
```
Expand All @@ -64,24 +66,24 @@ mvn license:update-project-license license:update-file-header

1. Add the following to your `~/.m2/settings.xml`:

```xml
<servers>
<server>
<id>bintray-openfasttrack-maven-repo</id>
<username>[bintray-username]</username>
<password>[bintray-api-key]</password>
</server>
</servers>
```
```xml
<servers>
<server>
<id>bintray-openfasttrack-maven-repo</id>
<username>[bintray-username]</username>
<password>[bintray-api-key]</password>
</server>
</servers>
```

2. Update version in `pom.xml`, commit and push.
3. Run command

```bash
mvn deploy
```
```bash
mvn deploy
```

4. Create a [release](https://github.com/itsallcode/openfasttrace/releases) on GitHub.
5. Sign in at https://bintray.com
6. Go to https://bintray.com/itsallcode/itsallcode/openfasttrace
5. Sign in at [bintray.com](https://bintray.com)
6. Go to the [bintray project page](https://bintray.com/itsallcode/itsallcode/openfasttrace)
7. There should be a notice saying "You have 6 unpublished item(s) for this package". Click the "Publish" link.
Loading

0 comments on commit 044dab5

Please sign in to comment.