Skip to content

Commit be60b29

Browse files
committed
Some CHANGELOG.md updates.
1 parent 7afd4f7 commit be60b29

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

CHANGELOG.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
#### Added
1313

14-
- Crates.io publishing for Maelstrom. `cargo install cargo-maelstrom` now works.
15-
- Internal documentation for how to cut a release and for how to set up a
16-
development environment.
14+
- Crates.io publishing for Maelstrom. `cargo install cargo-maelstrom` now
15+
works. See: [cargo-maelstrom](https://crates.io/crates/cargo-maelstrom),
16+
[maelstrom-worker](https://crates.io/crates/maelstrom-worker),
17+
[maelstrom-broker](https://crates.io/crates/maelstrom-broker), etc.
18+
- [Internal documentation](doc/contributing.md) for how to cut a release and
19+
for how to set up a development environment.
1720
- [A community Discord server](https://discord.gg/gcNEdpjr).
1821
- Support for Aarch64. The whole project can run on Arm or Intel/AMD processors
1922
now.
2023
- Support for specifying layers using "manifests". A manifest is like a tar
2124
file except that it only contains metadata. File contents are represented as
2225
SHA-256 digests. The consumer of a manifest must request the individual file
2326
contents separately, based on their SHA-256 digests. Manifests offer a number
24-
of advantages over tar files in some cases:
27+
of advantages over tar files:
2528
- When generating a manifest, the client only needs to compute checksums for
2629
those files that have actually changed.
2730
- Individual files can be cached on the broker, reducing the amount of data
28-
that needs to be transferred from the clien to the broker.
31+
that needs to be transferred from the client to the broker.
2932
- It is a lot easier for the client to generate a manifest without first
3033
copying all of the contents.
31-
- Scripts for doing CI steps locally. Now, a developer should be able to test
32-
CI scripts locally on their own machines. These scripts use `nix develop`
33-
under the hood.
34+
- [Scripts](scripts/) for doing CI steps locally. Now, a developer should be
35+
able to test CI scripts locally on their own machines. These scripts use `nix
36+
develop` under the hood.
3437

3538
### `cargo-maelstrom`
3639

@@ -65,7 +68,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
6568

6669
#### Changed
6770

68-
- The way syscalls are done. We created a new package -- `maelstrom-linux` to
71+
- The way syscalls are done. We created a new package &mdash `maelstrom-linux` &mdash to
6972
encapsulate all of the syscalls we use. This crate directly uses `libc`
7073
instead of depending on `nix` and `nc`. This was motivated by adding Aarch64
7174
support.

0 commit comments

Comments
 (0)