Move tutorial to readme #284
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…D to GitHub-flavored MD
Bodigrim
approved these changes
Sep 6, 2025
| Even better, the `--output` option directs our program to write a | ||
| report to the file [`fibber.html`](fibber.html). | ||
|
|
||
| ```shellsession |
RyanGlScott
reviewed
Sep 6, 2025
Member
RyanGlScott
left a comment
RyanGlScott
left a comment
There was a problem hiding this comment.
Awesome, thank you for working on this @ulysses4ever!
| kernel density estimate was built. The $x$ axis indicates the number | ||
| of loop iterations, while the $y$ axis shows measured execution time | ||
| for the given number of iterations. The line "behind" the values is a | ||
| for the given number of iterations. The line “behind” the values is a |
Member
There was a problem hiding this comment.
Genuinely curious: what is the rationale for using this style of double quotes?
Contributor
Author
There was a problem hiding this comment.
FTR it's a separate commit and we can revert it if you want.
Tldr; It's typography 101. A longer answer from the top of Google search: https://practicaltypography.com/straight-and-curly-quotes.html (fun fact: being in Indiana, you might have heard of the author, a prominent Racketeer at one point)
Co-authored-by: Ryan Scott <ryan.gl.scott@gmail.com>
Co-authored-by: Ryan Scott <ryan.gl.scott@gmail.com>
RyanGlScott
approved these changes
Sep 6, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #278 /cc @RyanGlScott @Bodigrim
The main change is merging
www/tutorial.mdintoREADME.markdown, but there are a lot of moving pieces. I tried to triple-check things (even used a local Hackage instance), but bugs are still possible; the main complexity is making sure the pandoc-flavored document correctly translates into GFM. I created several commits so that it may be easier to get an overview of changes (should probably be squashed in the end).The images do not render yet because, as @Bodigrim suggested, the links point to Hackage. So, this change will require a release. I took liberty to bump the version number and added a changelog entry for that reason.
There was a lot of redundancy between the following: the cabal file description, readme, www/index.md, www/tutorial.md. I tried to clean it up as much as possible.
I purged all dead code, including things like the HTML template file that was used to generate the website pages and the splash screen in the header of the old site. Arguably, they bear some historical value. But since we're using VCS, I don't see a reason to preserve them on
master. Also, the old site is (hopefully) always on Web Archive.