Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md with link to CONTRIBUTING.md #1698

Merged
merged 2 commits into from
Feb 5, 2025
Merged

docs: Update README.md with link to CONTRIBUTING.md #1698

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a60e431
docs: Update README.md with link to CONTRIBUTING.md
MingweiSamuel Feb 4, 2025
6cc1e11
fixup! docs: Update README.md with link to CONTRIBUTING.md
MingweiSamuel Feb 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Hydro provides a [high-level API](https://hydro.run/docs/hydro) that allows you

> Internally, the Hydro stack compiles Hydro programs into a low-level single-threaded DataFlow Internal Representation (IR) language called [DFIR](https://hydro.run/docs/dfir); each Hydro process corresponds to a separate DFIR program. In rare cases you may want to hand-author one or more processes in DFIR; see the DFIR [documentation](https://hydro.run/docs/dfir) or [examples](https://github.com/hydro-project/hydro/tree/main/dfir_rs/examples) for details.

## Development Setup
## Developer Quick Start

See the [quickstart section of the Hydro book](https://hydro.run/docs/hydro/quickstart/) for instructions on installing Rust and getting started with the Hydro template.

Expand All @@ -47,7 +47,7 @@ What's wanted, we believe, is a proper language stack addressing distributed con

[Hydro](https://hydro.run) is a Rust framework for distributed programming that is designed to address these goals.

# Learning More
# Learn More
The Hydro project's main website is at [https://hydro.run](https://hydro.run).

- **Docs**: There are docs for the [high-level Hydro language](https://hydro.run/docs/hydro/) and the low-level dataflow IR, [DFIR](https://hydro.run/docs/dfir), as well as the [Hydro Deploy](https://hydro.run/docs/deploy) framework for launching Hydro programs.
Expand All @@ -56,3 +56,7 @@ The Hydro project's main website is at [https://hydro.run](https://hydro.run).
- The original Hydro vision paper from CIDR 2021: [New Directions in Cloud Programming](https://hydro.run/papers/new-directions.pdf)
- The first paper on optimizations from SIGMOD 2024: [Optimizing Distributed Protocols with Query Rewrites](https://hydro.run/papers/david-sigmod-2024.pdf)
- The first paper on Hydro's formal semantics to appear in POPL 2025: [Flo: a Semantic Foundation for Progressive Stream Processing](https://arxiv.org/abs/2411.08274)

# Contributing

For Hydro development setup and contribution info, see [CONTRIBUTING.md](CONTRIBUTING.md).
Loading