git.iko.soy/streamly
on master help sign in
Rename README.md to docs/Introduction.md and fix broken links
commit8be36018a16061d1dfb0ea72056dc1e6f636e1c9 authorAdithya Kumar <adithya@composewell.com> dateMon 7 Feb 2022, 04:22 (5 years ago) parentfabefee
5 files changed+10−10
compare with master
unifiedsplit
CONTRIBUTING.md+1−1 README.md → docs/Introduction.md+6−6 docs/faq.md+1−1 docs/getting-started.md+1−1 docs/unified-abstractions.md+1−1
CONTRIBUTING.md+1−1
@@ -90,7 +90,7 @@ Here is a quick checklist for a PR, for details please see the next section:
9090* [Performance benchmarks](benchmark) are added, where applicable
9191* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
9292* Haddock documentation is added to user visible APIs and data types
93−* Tutorial module, [README](README.md), and [guides](docs) are updated if
93+* Tutorial module, [README](docs/Introduction.md), and [guides](docs) are updated if
9494 necessary.
9595* [Changelog](Changelog.md) is updated if needed
9696* The code conforms to the license, it is not stolen, credit is given,
README.md → docs/Introduction.mdrenamed+6−6
@@ -43,11 +43,11 @@ further reading.
4343If you wish to follow along with this guide, you will need to have
4444[Streamly][] installed.
4545
46−Please see the [Getting Started With The Streamly Package](docs/getting-started.md)
46+Please see the [Getting Started With The Streamly Package](getting-started.md)
4747guide for instructions on how to install [Streamly][].
4848
4949If you wish to run benchmarks, please be sure to build your
50−application using the instructions in the [Build Guide](docs/building.md).
50+application using the instructions in the [Build Guide](building.md).
5151
5252### An overview of the types used in these examples
5353
@@ -490,7 +490,7 @@ Examples][streamly-examples] web page.
490490* [Streaming Benchmarks][streaming-benchmarks]
491491* [Concurrency Benchmarks][concurrency-benchmarks]
492492* Functional Conf 2019 [Video](https://www.youtube.com/watch?v=uzsqgdMMgtk) | [Slides](https://www.slideshare.net/HarendraKumar10/streamly-concurrent-data-flow-programming)
493−* [Other Guides](docs/)
493+* [Other Guides](./)
494494* [Streamly Homepage][Streamly]
495495
496496## Performance
@@ -595,7 +595,7 @@ significant way:
595595 * Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))
596596 * Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))
597597
598−Please see the [`credits`](./docs/Credits.md) directory for a full
598+Please see the [`credits`](./Credits.md) directory for a full
599599list of contributors, credits and licenses.
600600
601601## Licensing
@@ -646,6 +646,6 @@ links (for online docs) before we release.
646646[CirclingSquare.hs]: https://github.com/composewell/streamly-examples/tree/master/examples/CirclingSquare.hs
647647
648648<!-- local files -->
649−[LICENSE]: LICENSE
650−[CONTRIBUTING.md]: CONTRIBUTING.md
649+[LICENSE]: ../LICENSE
650+[CONTRIBUTING.md]: ../CONTRIBUTING.md
651651[docs]: docs/
docs/faq.md+1−1
@@ -2,7 +2,7 @@
22
33This document provides idioms or examples to solve common programming
44problems using streamly. To start with please go through [Streamly Quick
5−Overview](../README.md) and [`Streamly examples repository`][streamly-examples].
5+Overview](./Introduction.md) and [`Streamly examples repository`][streamly-examples].
66This document provides additional examples.
77
88## Distribute and Zip Concurrently
docs/getting-started.md+1−1
@@ -279,7 +279,7 @@ streamly][streamly-github] on Github.
279279If you got this far successfully, congratulations!
280280
281281* For an overview of the `streamly` package, please read the
282− [Streamly Quick Overview](../README.md).
282+ [Streamly Quick Overview](./Introduction.md).
283283* Please browse the code examples in the
284284 [`Streamly examples repository`][streamly-examples].
285285* If you would like to start on a real world project, please take a
docs/unified-abstractions.md+1−1
@@ -8,7 +8,7 @@ ecosystem.
88This document discusses the related packages in the Haskell ecosystem
99and how streamly unifies, overlaps, or compares with those. We provide
1010simple code snippets for illustrations, for a better overview of the
11−library please see the [Streamly Quick Overview](../README.md) document.
11+library please see the [Streamly Quick Overview](./Introduction.md) document.
1212
1313## Existing Haskell Libraries
1414