<p align="center">
  <a href="https://technodisaster.com/">
    <img src="android/fastlane/metadata/android/en-US/images/featureGraphic.png" >
  </a>

  <p align="center">
    <a href="https://github.com/Techno-Disaster/tldr-flutter/issues/new?template=bug_report.md">Report bug</a>
    ·
    <a href="https://github.com/Techno-Disaster/tldr-flutter/issues/new?template=feature_request.md">Request feature</a>
  </p>
</p>

[![GitHub All Releases](https://img.shields.io/github/downloads/Techno-Disaster/tldr-flutter/total.svg)](https://github.com/Techno-Disaster/tldr-flutter/releases/latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![bloc](https://img.shields.io/badge/flutter-bloc-blue)](https://github.com/felangel/bloc)


## Table of contents

- [Overview](#overview)
- [Screenshots](#screenshots)
- [Build and run](#build-and-run)
- [Bugs and feature requests](#bugs-and-feature-requests)
- [Contributing](#contributing)
- [Copyright and license](#copyright-and-license)

## Overview

|[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" alt="Get it on Google Play" width="185px" />](https://play.google.com/store/apps/details?id=wtf.technodisaster.tldr) |[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/packages/wtf.technodisaster.tldr/) |
|-|-|

The [tldr pages](https://github.com/tldr-pages/tldr) project is a collection of community-maintained help pages for command-line tools, that aims to be a simpler, more approachable complement to traditional man pages.

Maybe you are new to the command-line world? Or just a little rusty? Or perhaps you can't always remember the arguments to lsof, or tar?

It certainly doesn't help that the first option explained in man tar is:
```
-b blocksize
Specify the block size, in 512-byte records, for tape drive I/O.
```

This app is just that: an ever-growing collection of examples for the most common UNIX, Linux, macOS, SunOS and Windows command-line tools.

## Screenshots

|![](android/fastlane/metadata/android/en-US/images/phoneScreenshots/1_en-US.png)|![](android/fastlane/metadata/android/en-US/images/phoneScreenshots/2_en-US.png)|![](android/fastlane/metadata/android/en-US/images/phoneScreenshots/3_en-US.png)|![](android/fastlane/metadata/android/en-US/images/phoneScreenshots/4_en-US.png)|![](android/fastlane/metadata/android/en-US/images/phoneScreenshots/5_en-US.png)|
|---|---|---|---|---|

## Build and run
* Assuming this is your first project, install [flutter](https://flutter.dev/docs/get-started/install)
* Clone this project using the url or ssh and cd into the cloned directory
* Get the dependencies with ``` flutter pub get ```
* Run the app in debug mode with ``` flutter run ```

## Bugs and feature requests

[Please open a new issue](https://github.com/Techno-Disaster/tldr-flutter/issues/new?template=bug_report.md).

## Contributing

Currently open to all contributions. Hit those issue and PR buttons.

### Thanks

* [tldr-pages](https://github.com/tldr-pages/tldr) for command documentation and logo
* [Hotpot.ai](https://github.com/HotpotDesign) for the screenshot templates and graphics generatorw
* [Cas van Luijtelaar](https://flare.rive.app/a/cvl/files/flare/site-animaton/embed) for the flare url

## Copyright and license

Code released under the [MIT License](https://github.com/Techno-Disaster/tldr-flutter/blob/master/LICENSE).
