mirror of
https://github.com/salsa-rs/salsa.git
synced 2025-01-12 08:30:51 +00:00
introduce the basic structure of a book (very much a WIP)
This commit is contained in:
parent
d9098e30cf
commit
e5d9409d46
8 changed files with 44 additions and 0 deletions
1
book/.gitignore
vendored
Normal file
1
book/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
book
|
5
book/book.toml
Normal file
5
book/book.toml
Normal file
|
@ -0,0 +1,5 @@
|
|||
[book]
|
||||
authors = ["Niko Matsakis"]
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Salsa"
|
7
book/src/SUMMARY.md
Normal file
7
book/src/SUMMARY.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
# Summary
|
||||
|
||||
- [About salsa](./about_salsa.md)
|
||||
- [How to use Salsa](./how_to_use.md)
|
||||
- [How Salsa works](./how_salsa_works.md)
|
||||
- [Common patterns](./common_patterns.md)
|
||||
- [YouTube videos](./videos.md)
|
17
book/src/about_salsa.md
Normal file
17
book/src/about_salsa.md
Normal file
|
@ -0,0 +1,17 @@
|
|||
# About salsa
|
||||
|
||||
Salsa is a Rust framework for writing incremental, on-demand programs
|
||||
-- these are programs that want to adapt to changes in their inputs,
|
||||
continuously producing a new output that is up-to-date. Salsa is based
|
||||
on the the incremental recompilation techniques that we built for
|
||||
rustc, and many (but not all) of its users are building compilers or
|
||||
other similar tooling.
|
||||
|
||||
If you'd like to learn more about Salsa, you can check out [the [Hello
|
||||
World
|
||||
example](https://github.com/salsa-rs/salsa/blob/master/examples/hello_world/main.rs)
|
||||
in the repository, or watch some of our [YouTube videos](./videos.md).
|
||||
|
||||
If you'd like to chat about Salsa, or you think you might like to
|
||||
contribute, please jump on to our Zulip instance at
|
||||
[salsa.zulipchat.com](https://salsa.zulipchat.com/).
|
1
book/src/common_patterns.md
Normal file
1
book/src/common_patterns.md
Normal file
|
@ -0,0 +1 @@
|
|||
# Common patterns
|
1
book/src/how_salsa_works.md
Normal file
1
book/src/how_salsa_works.md
Normal file
|
@ -0,0 +1 @@
|
|||
# How Salsa works
|
1
book/src/how_to_use.md
Normal file
1
book/src/how_to_use.md
Normal file
|
@ -0,0 +1 @@
|
|||
# How to use Salsa
|
11
book/src/videos.md
Normal file
11
book/src/videos.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
# YouTube videos
|
||||
|
||||
There are currently two videos about Salsa available:
|
||||
|
||||
- [How Salsa Works](https://youtu.be/_muY4HjSqVw), which gives a
|
||||
high-level introduction to the key concepts involved and shows how
|
||||
to use salsa;
|
||||
- [Salsa In More Depth](https://www.youtube.com/watch?v=i_IhACacPRY),
|
||||
which digs into the incremental algorithm and explains -- at a
|
||||
high-level -- how Salsa is implemented.
|
||||
|
Loading…
Reference in a new issue