https://github.com/techno-disaster/tldr-flutter

simplified man-pages, a tldr.sh client
https://github.com/techno-disaster/tldr-flutter

commands-cheat-sheet linux man-pages tldr tldr-client tldr-pages

Last synced: 3 days ago
JSON representation

simplified man-pages, a tldr.sh client

• Host: GitHub
• URL: https://github.com/techno-disaster/tldr-flutter
• Owner: techno-disaster
• License: mit
• Created: 2021-02-14T02:58:49.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T01:48:46.000Z (20 days ago)
• Last Synced: 2024-10-30T04:00:08.773Z (20 days ago)
• Topics: commands-cheat-sheet, linux, man-pages, tldr, tldr-client, tldr-pages
• Language: Dart
• Homepage: https://play.google.com/store/apps/details?id=wtf.technodisaster.tldr
• Size: 560 MB
• Stars: 119
• Watchers: 5
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  

  


    Report bug

    ·

    Request feature

  


[![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

|[](https://play.google.com/store/apps/details?id=wtf.technodisaster.tldr) |[](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).