Skip to main content

A Markdown document viewer for the terminal

Project description

Discord

Frogmouth

Frogmount is a terminal-based Markdown application for viewing and browsing Markdown files.

Installing

The easiest way to install Frogmouth is with pipx. If you have pipx installed, run the following:

pipx install frogmouth

You can also install Frogmouth as a Python package with pip:

pip install frogmouth

TODO

Using

TODO

Developing

To get the source (actually not quite this, fork then clone your own; this is a placeholder):

$ git clone git@github.com:Textualize/frogmouth.git

To set up the development environment:

$ make setup

To run the development version:

$ make

To see other make targets:

$ make help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frogmouth-0.1.0.tar.gz (25.0 kB view hashes)

Uploaded Source

Built Distribution

frogmouth-0.1.0-py3-none-any.whl (37.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page