{"id":13441371,"url":"https://github.com/octobanana/fltrdr","last_synced_at":"2025-03-20T11:38:34.492Z","repository":{"id":100906224,"uuid":"171271078","full_name":"octobanana/fltrdr","owner":"octobanana","description":"A TUI text reader for the terminal.","archived":false,"fork":false,"pushed_at":"2019-05-10T02:39:49.000Z","size":1506,"stargazers_count":483,"open_issues_count":4,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-08-01T03:34:10.049Z","etag":null,"topics":["reader","terminal","text","tui"],"latest_commit_sha":null,"homepage":"https://octobanana.com/software/fltrdr","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/octobanana.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-02-18T11:23:25.000Z","updated_at":"2024-05-31T17:02:37.000Z","dependencies_parsed_at":"2023-06-10T16:30:36.424Z","dependency_job_id":null,"html_url":"https://github.com/octobanana/fltrdr","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octobanana%2Ffltrdr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octobanana%2Ffltrdr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octobanana%2Ffltrdr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/octobanana%2Ffltrdr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/octobanana","download_url":"https://codeload.github.com/octobanana/fltrdr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221759961,"owners_count":16876325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["reader","terminal","text","tui"],"created_at":"2024-07-31T03:01:33.212Z","updated_at":"2024-10-28T01:30:41.395Z","avatar_url":"https://github.com/octobanana.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"# Fltrdr\nA TUI text reader for the terminal.\n\n[![fltrdr](https://raw.githubusercontent.com/octobanana/fltrdr/master/assets/fltrdr.gif)](https://octobanana.com/software/fltrdr/blob/assets/fltrdr.mp4#file)\n\nClick the above gif to view a video of __Fltrdr__ in action.\n\n## Contents\n* [About](#about)\n  * [Features](#features)\n* [Usage](#usage)\n* [Terminal Compatibility](#terminal-compatibility)\n* [Pre-Build](#pre-build)\n  * [Dependencies](#dependencies)\n  * [Linked Libraries](#linked-libraries)\n  * [Included Libraries](#included-libraries)\n  * [Environment](#environment)\n  * [macOS](#macos)\n* [Build](#build)\n* [Install](#install)\n* [Configuration](#configuration)\n* [License](#license)\n\n## About\n__Fltrdr__, or *flat-reader*, is an interactive text reader for the terminal.\nIt is *flat* in the sense that the reader is word-based. It creates a\nhorizontal stream of words by ignoring all newline characters and removing\nsequential whitespace.\nIts purpose is to facilitate reading, scanning, and searching text.\nThe program has a play mode that moves the reader forward one word at a time,\nalong with a configurable words per minute (WPM) setting.\nIt can be used to read text from either a file or stdin.\n\n### Features\n* word-based text reader\n* *vi* inspired key-bindings\n* read UTF-8 encoded text from a file or stdin\n* play mode with variable speed controlled through WPM\n* in play mode, longer pauses occur on words that end in punctuation\n* focus point to align the current word\n* focus point tries to be smart about its placement,\n  ignoring any surrounding punctuation or plurality\n* search forwards and backwards using regular expressions\n* command prompt to interact with the program\n* store your settings in a configuration file\n* choose how many words are shown at a time\n* colours can be customized\n* chars/symbols can be customized\n* show/hide parts of the interface\n* mouse support for play/pause and scrolling text\n* history file for command prompt inputs\n* history file for search prompt inputs\n* fuzzy search prompt input history based on current prompt input\n* load and save reader state to continue where you last left off\n\n## Usage\nView the usage and help output with the `--help` or `-h` flag.\nThe help output contains the documentation for the key bindings\nand commands for customization.\n\n## Terminal Compatibility\nThis program uses raw terminal control sequences to manipulate the terminal,\nsuch as moving the cursor, styling the output text, and clearing the screen.\nAlthough some of the control sequences used may not work as intended on all terminals,\nthey should work fine on any modern terminal emulator.\n\n## Pre-Build\nThis section describes what environments this program may run on,\nany prior requirements or dependencies needed,\nand any third party libraries used.\n\n\u003e #### Important\n\u003e Any shell commands using relative paths are expected to be executed in the\n\u003e root directory of this repository.\n\n### Dependencies\n* __C++17__ compiler/library\n* __CMake__ \u003e= 3.8\n* __ICU__ \u003e= 62.1\n* __OpenSSL__ \u003e= 1.1.0\n\n### Linked Libraries\n* __stdc++fs__ (libstdc++fs) included in the C++17 Standard Library\n* __crypto__ (libcrypto) part of the OpenSSL Library\n* __icuuc__ (libicuuc) part of the ICU library\n* __icui18n__ (libicui18n) part of the ICU library\n\n### Included Libraries\n* [__parg__](https://github.com/octobanana/parg):\n  for parsing CLI args, included as `./src/ob/parg.hh`\n\n### Environment\n* __Linux__ (supported)\n* __BSD__ (supported)\n* __macOS__ (supported)\n\n### macOS\nUsing a new version of __gcc__ or __llvm__ is __required__, as the default\n__Apple llvm compiler__ does __not__ support C++17 Standard Library features such as `std::filesystem`.\n\nA new compiler can be installed through a third-party package manager such as __Brew__.\nAssuming you have __Brew__ already installed, the following commands should install\nthe latest __gcc__.\n\n```\nbrew install gcc\nbrew link gcc\n```\n\nThe following line will then need to be appended to the CMakeLists.txt file.\nReplace the placeholder `\u003cpath-to-g++\u003e` with the canonical path to the new __g++__ compiler binary.\n\n```\nset (CMAKE_CXX_COMPILER \u003cpath-to-g++\u003e)\n```\n\n## Build\nThe following shell command will build the project in release mode:\n```sh\n./build.sh\n```\nTo build in debug mode, run the script with the `--debug` flag.\n\n## Install\nThe following shell command will install the project in release mode:\n```sh\n./install.sh\n```\nTo install in debug mode, run the script with the `--debug` flag.\n\n## Configuration\n\nBase Config Directory (BASE): `${HOME}/.fltrdr`  \nState Directory: `BASE/state`  \nHistory Directory: `BASE/history`  \nConfig File: `BASE/config`  \nState Files: `BASE/state/\u003ccontent-id\u003e`  \nSearch History File: `BASE/history/search`  \nCommand History File: `BASE/history/command`\n\nUse `--config=\u003cfile\u003e` to override the default config file.  \nUse `--config-base=\u003cdir\u003e` to override the default base config directory.\n\nThe base config directory and config file must be created by the user.\nThe config file in the base config directory must be named `config`.\nIt is a plain text file that can contain any of the\ncommands listed in the __Commands__ section of the `--help` output.\nEach command must be on its own line. Lines that begin with the\n`#` character are treated as comments.\n\nIf you want to permanently use a different base config directory,\nsuch as `~/.config/fltrdr`, add the following line to your shell profile:\n```sh\nalias fltrdr=\"fltrdr --config-base ~/.config/fltrdr\"\n```\n\nThe following shell commands will create the base config directory\nin the default location and copy over the example config file:\n```sh\nmkdir -pv ~/.fltrdr\ncp -uv ./config/default ~/.fltrdr/config\n```\n\nSeveral config file examples can be found in the `./config` directory.\n\n## License\nThis project is licensed under the MIT License.\n\nCopyright (c) 2019 [Brett Robinson](https://octobanana.com/)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctobanana%2Ffltrdr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctobanana%2Ffltrdr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctobanana%2Ffltrdr/lists"}