Skip to content

Commit 33b4a19

Browse files
committed
Cleanup the repo a little bit after Rust Reference decision
There is still more two do, but this tries to at least reduce the confusion that this repo is actively being worked on at this point in time.
1 parent 176bb6f commit 33b4a19

File tree

4 files changed

+4
-21
lines changed

4 files changed

+4
-21
lines changed

README.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
11
# The Rust Specification
22

3-
## Building
3+
## The Spec and the Rust Reference
44

5-
The specification uses [mdBook] to process the source into HTML. See [mdBook Installation] for more information on installing mdBook. To build the book, run:
5+
** The Rust specification is currently being developed as part of the [Rust Reference](https://github.com/rust-lang/reference).
66

7-
```sh
8-
mdbook build
9-
```
7+
The [`t-spec`](https://www.rust-lang.org/governance/teams/lang#team-spec) team, in consultation with interested parties from the Rust Project, made the decision on a [go-forward plan](https://hackmd.io/d-8LXh2NTASg7NF-zmZqNA?both#Review-go-forward-plan) that makes the Rust Reference the source of truth and the specification will be based on that content.
108

11-
This will output the HTML into a directory called `book`.
12-
13-
For authors, consider using the server functionality which supports automatic reload:
14-
15-
```sh
16-
mdbook serve --open
17-
```
18-
19-
This will open a browser with a websocket live-link to automatically reload whenever the source is updated.
20-
21-
[mdBook]: https://rust-lang.github.io/mdBook/
22-
[mdBook Insallation]: https://rust-lang.github.io/mdBook/guide/installation.html
9+
It is currently unclear what happens to both this repository and the Rust reference once we are at a steady-state of having a usable specification. It is likely we will consolidate the two repositories into one that ends up being called the specification. Stay tuned for more information on that.
2310

2411
## License
2512

spec/README.md

Whitespace-only changes.

spec/SUMMARY.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

spec/introduction.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)