git.iko.soy/streamly
on master help sign in
Rename the design dir to dev
7c5fd94Harendra Kumar
CONTRIBUTING.md+5−4
compare with master
unifiedsplit
@@ -182,15 +182,16 @@ copying does not have an associated license please do not use it.
182
182
183## Developer documentation
183## Developer documentation
184
184
185−To build haddock documentation for all modules, including the ones not exposed
185+To build haddock documentation:
186−to users of the library, use the following commands:
187
186
188```
187```
189$ cabal haddock
188$ cabal haddock
190−$ stack haddock --no-haddock-deps
191```
189```
192
190
191+Open the link printed at the end of the output of this command, in
192+your browser.
193+
193−For design documentation see the `design` directory.
194+For general library developer documentation see the `dev` directory.
194
195
195## Coding Guidelines
196## Coding Guidelines
196
197
design/ci-tests.md → dev/ci-tests.mdrenamed

The content is the same.

design/container-api.md → dev/container-api.mdrenamed

The content is the same.

design/cps-vs-direct.rst → dev/cps-vs-direct.rstrenamed

The content is the same.

design/dfa-bytes.png → dev/dfa-bytes.pngrenamed

Binary file not shown.

design/dfa-classes.png → dev/dfa-classes.pngrenamed

Binary file not shown.

design/dfa-rearr.png → dev/dfa-rearr.pngrenamed

Binary file not shown.

design/linked-lists.md → dev/linked-lists.mdrenamed

The content is the same.

design/module-organization.md → dev/module-organization.mdrenamed

The content is the same.

design/optimization-guidelines.md → dev/optimization-guidelines.mdrenamed

The content is the same.

design/paths.rst → dev/paths.rstrenamed

The content is the same.

design/related-packages.md → dev/related-packages.mdrenamed

The content is the same.

design/resources.md → dev/resources.mdrenamed

The content is the same.

design/roadmap.md → dev/roadmap.mdrenamed

The content is the same.

design/unicode.md → dev/unicode.mdrenamed

The content is the same.

design/utf8-decoder.md → dev/utf8-decoder.mdrenamed

The content is the same.

streamly.cabal+3−3
@@ -97,9 +97,9 @@ extra-source-files:
97 credits/transient-0.5.5.txt
97 credits/transient-0.5.5.txt
98 credits/vector-0.12.0.2.txt
98 credits/vector-0.12.0.2.txt
99 default.nix
99 default.nix
100− design/*.md
100+ dev/*.md
101− design/*.png
101+ dev/*.png
102− design/*.rst
102+ dev/*.rst
103 docs/*.md
103 docs/*.md
104 docs/*.hs
104 docs/*.hs
105 docs/*.svg
105 docs/*.svg