Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nit: Format README.md for (subjective) readability #40

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Nit: Format README.md for (subjective) readability #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 29 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# mandown - mdn
# mandown - `mdn`

A man-page inspired Markdown pager written in C.

Expand All @@ -20,37 +20,53 @@ Need to lookup things from README? Or from manual page? Or perhaps just want to

## Installation

Current version is still being developed for some HTML tags. However, it should work on most Markdown documents.
### Homebrew (MacOS)

### Homebrew
```shell
$ brew install mandown
```

The installed binary `mdn` would be at `/usr/local/bin/`


### From source (e.g. Debian)

Mandown requires `libncurses(w)` and `libxml2` as compile-time dependencies.

Make sure you have them installed before compiling.

```shell
$ apt-get install libncursesw5-dev
$ apt-get install libxml2-dev
```

Clone the repo:

```shell
$ git clone https://github.com/Titor8115/mandown.git
```

Build the binary:

```shell
$ cd mandown
$ make install
```

To remove the binary, you can run the commands below, or remove manually.
To remove the binary, you can run the commands below, or remove manually:

```shell
$ cd mandown
$ make uninstall
```

If you just want to compile and test it.
If you just want to compile and test it:

```shell
$ cd mandown
$ make
```

Feel free to create an issue.

## Usage

Check out the new sample
Expand All @@ -59,6 +75,7 @@ Check out the new sample
$ mdn sample.md
```

<blockquote>
Mouse wheel scrolling is supported! (if your terminal emulator allows)

Scroll Up: <kbd>↑</kbd>, <kbd>k</kbd>
Expand All @@ -74,22 +91,16 @@ Select & Get href: <kbd>tab</kbd> or double click <kbd>mouse 1</kbd> & <kbd>ente
Exit: <kbd>q</kbd>

To read detailed usage, run `mdn -h`
</blockquote>

## Library dependency

Mandown requires `libncurses(w)` and `libxml2` as compile-time dependencies.

Make sure you have them installed before compiling.

### Debian
## Contributing

```shell
$ apt-get install libncursesw5-dev
$ apt-get install libxml2-dev
```
Feel free to create an issue.

## Todo

❗Current version is still being developed for some HTML tags. However, it should work on most Markdown documents.

- [x] Line fold/wrap on white space
- [x] Optimized resizing
- [ ] Table and contents rendering
Expand Down