Skip to content

Commit c2e5b94

Browse files
committed
improve readme
1 parent c48b3b6 commit c2e5b94

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

README-pre-process.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ To read more about how `filter` work, visit the [this](https://pandoc.org/filter
5252

5353
- [Stack](https://docs.haskellstack.org/en/stable/README/)
5454

55-
Currently, this filter can be installed from the source (it will be available on Hackage once the tool is stable).
5655

56+
### From Source
5757
``` shell
5858

5959
git clone https://github.com/gdevanla/pandoc-markdown-ghci-filter.git
@@ -62,6 +62,18 @@ cd pandoc-markdown-ghci-filter
6262
stack build
6363

6464
stack setup # Note, this command copies this tool to ~/.local/bin.
65+
```
66+
67+
### From Hackage
68+
69+
``` shell
70+
stack build pandoc-markdown-ghci-filter # executable only available to local stack environment
71+
72+
or
73+
74+
stack install pandoc-markdown-ghci-filter # if you want to across all stack environments
75+
76+
```
6577

6678
# test it on a test_markdown file
6779

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,7 @@ Requirements
6868

6969
- [Stack](https://docs.haskellstack.org/en/stable/README/)
7070

71-
Currently, this filter can be installed from the source (it will be
72-
available on Hackage once the tool is stable).
71+
### From Source
7372

7473
``` {.shell}
7574
@@ -79,12 +78,26 @@ cd pandoc-markdown-ghci-filter
7978
stack build
8079
8180
stack setup # Note, this command copies this tool to ~/.local/bin.
81+
```
82+
83+
### From Hackage
84+
85+
``` {.shell}
86+
stack build pandoc-markdown-ghci-filter # executable only available to local stack environment
8287
83-
# test it on a test_markdown file
88+
or
8489
85-
pandoc -s -t json README.md | pandoc-markdown-ghci-filter-exe | pandoc -f json -t markdown
90+
stack install pandoc-markdown-ghci-filter # if you want to across all stack environments
8691
```
8792

93+
test it on a test\_markdown file
94+
================================
95+
96+
pandoc -s -t json README.md | pandoc-markdown-ghci-filter-exe | pandoc
97+
-f json -t markdown
98+
99+
\`\`\`
100+
88101
Usage Notes/Caveats
89102
===================
90103

0 commit comments

Comments
 (0)