xemantic-project-template

A template repository for Xemantic's Kotlin multiplatform projects

Why?

Creating new gradle projects, with all the conventions we are using at Xemantic, might be a hassle.

Usage

Note

There is no value in using this project directly as a dependency, however the usage section is included, so you can replace it with your project dependency:

In build.gradle.kts add:

dependencies {
    implementation("com.xemantic.template:xemantic-project-template:0.1.0")
}

How?

1. When creating new GitHub project choose this repository as a template
2. Follow the CHECKLIST

Development

See DEVELOPMENT.md for maintenance notes — updating the gradle wrapper and the project dependencies.

Documentation conventions

All the Markdown files in this project are authored with semantic line breaks. Each sentence starts on its own line, and long sentences may be split further at clause boundaries. This keeps git diff and code review focused on the sentence that actually changed, instead of on a whole reflowed paragraph.

There is no maximum line length, and paragraphs are never hard-wrapped to a fixed column. Line length is a rendering concern, so it is left to the editor.

Markdown soft wrapping in the IDE

IntelliJ IDEA: Settings → Editor → General → Soft Wraps, enable Soft-wrap these files and make sure the mask contains *.md (the default mask already does). To toggle it for the file at hand only, use View → Active Editor → Soft-Wrap.

VS Code: add the following to your settings.json:

{
  "[markdown]": {
    "editor.wordWrap": "on"
  }
}

Alternatively toggle it for the current file with Alt+Z (Option+Z on macOS).