git.iko.soy/streamly
on master help sign in
Rename README.md to docs/Introduction.md and fix broken links
8be3601Adithya Kumar
CONTRIBUTING.md+1−1
compare with master
unifiedsplit
@@ -90,7 +90,7 @@ Here is a quick checklist for a PR, for details please see the next section:
90* [Performance benchmarks](benchmark) are added, where applicable
90* [Performance benchmarks](benchmark) are added, where applicable
91* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
91* No significant regressions are reported by [performance benchmarks](benchmark/README.md)
92* Haddock documentation is added to user visible APIs and data types
92* 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
94 necessary.
94 necessary.
95* [Changelog](Changelog.md) is updated if needed
95* [Changelog](Changelog.md) is updated if needed
96* The code conforms to the license, it is not stolen, credit is given,
96* 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.
43If you wish to follow along with this guide, you will need to have
43If you wish to follow along with this guide, you will need to have
44[Streamly][] installed.
44[Streamly][] installed.
45
45
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)
47guide for instructions on how to install [Streamly][].
47guide for instructions on how to install [Streamly][].
48
48
49If you wish to run benchmarks, please be sure to build your
49If 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).
51
51
52### An overview of the types used in these examples
52### An overview of the types used in these examples
53
53
@@ -490,7 +490,7 @@ Examples][streamly-examples] web page.
490* [Streaming Benchmarks][streaming-benchmarks]
490* [Streaming Benchmarks][streaming-benchmarks]
491* [Concurrency Benchmarks][concurrency-benchmarks]
491* [Concurrency Benchmarks][concurrency-benchmarks]
492* Functional Conf 2019 [Video](https://www.youtube.com/watch?v=uzsqgdMMgtk) | [Slides](https://www.slideshare.net/HarendraKumar10/streamly-concurrent-data-flow-programming)
492* 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](./)
494* [Streamly Homepage][Streamly]
494* [Streamly Homepage][Streamly]
495
495
496## Performance
496## Performance
@@ -595,7 +595,7 @@ significant way:
595 * Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))
595 * Gabriella Gonzalez ([foldl](https://hackage.haskell.org/package/foldl))
596 * Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))
596 * Alberto G. Corona ([transient](https://hackage.haskell.org/package/transient))
597
597
598−Please see the [`credits`](./docs/Credits.md) directory for a full
598+Please see the [`credits`](./Credits.md) directory for a full
599list of contributors, credits and licenses.
599list of contributors, credits and licenses.
600
600
601## Licensing
601## Licensing
@@ -646,6 +646,6 @@ links (for online docs) before we release.
646[CirclingSquare.hs]: https://github.com/composewell/streamly-examples/tree/master/examples/CirclingSquare.hs
646[CirclingSquare.hs]: https://github.com/composewell/streamly-examples/tree/master/examples/CirclingSquare.hs
647
647
648<!-- local files -->
648<!-- local files -->
649−[LICENSE]: LICENSE
649+[LICENSE]: ../LICENSE
650−[CONTRIBUTING.md]: CONTRIBUTING.md
650+[CONTRIBUTING.md]: ../CONTRIBUTING.md
651[docs]: docs/
651[docs]: docs/
docs/faq.md+1−1
@@ -2,7 +2,7 @@
2
2
3This document provides idioms or examples to solve common programming
3This document provides idioms or examples to solve common programming
4problems using streamly. To start with please go through [Streamly Quick
4problems 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].
6This document provides additional examples.
6This document provides additional examples.
7
7
8## Distribute and Zip Concurrently
8## Distribute and Zip Concurrently
docs/getting-started.md+1−1
@@ -279,7 +279,7 @@ streamly][streamly-github] on Github.
279If you got this far successfully, congratulations!
279If you got this far successfully, congratulations!
280
280
281* For an overview of the `streamly` package, please read the
281* For an overview of the `streamly` package, please read the
282− [Streamly Quick Overview](../README.md).
282+ [Streamly Quick Overview](./Introduction.md).
283* Please browse the code examples in the
283* Please browse the code examples in the
284 [`Streamly examples repository`][streamly-examples].
284 [`Streamly examples repository`][streamly-examples].
285* If you would like to start on a real world project, please take a
285* 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.
8This document discusses the related packages in the Haskell ecosystem
8This document discusses the related packages in the Haskell ecosystem
9and how streamly unifies, overlaps, or compares with those. We provide
9and how streamly unifies, overlaps, or compares with those. We provide
10simple code snippets for illustrations, for a better overview of the
10simple 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.
12
12
13## Existing Haskell Libraries
13## Existing Haskell Libraries
14
14