F# by Example

Content and build toolchain for F# by Example, a site that teaches F# via annotated example programs. Heavily inspired from Go by Example by Mark McGranaghan.

Overview

The F# by Example site is built by extracting code and comments from source files in examples and rendering them using templates into a static public directory. The programs implementing this build process are in tools, along with dependencies specified in the go.modfile.

The built public directory can be served by any static content system.

Building

To build the site you'll need Go installed. Run:

$ tools/build

To build continuously in a loop (allows for hot-reloading):

$ tools/build-loop

To see the site locally:

$ tools/serve

and open http://127.0.0.1:8000/ in your browser.

Add new examples

First create a new entry in examples.txt

...
...
Example

Then create a new folder for the example:

$ mkdir example

Create a fsx file which contains source code for that file and a sh file which resembles the output of that script

$ touch example.fsx example.sh

When you rebuild the app a hash file will automatically be created

example.hash

License

This work is a derivative of "Go by Example" by Mark McGranaghan, used under CC BY 3.0.

This work is licensed under CC BY 3.0 by Amir Panahi.

FAQ

I found a problem with the examples; what do I do?

We're very happy to fix problem reports and accept contributions! Please submit an issue or send a Pull Request. See CONTRIBUTING.md for more details.

What version of F# is required to run these examples?

TODO

I'm getting output in a different order from the example. Is the example wrong?

TODO

Why is there `open System` for each example

This is just for the first line of the code snippet to render the "copy" and "run in playground" buttons

License

arpxspace/fsharpbyexample

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages