Skip to content

Commit efeefb8

Browse files
docs(readme): beautify a bit (#96)
Co-authored-by: lena <[email protected]>
1 parent bd70ca2 commit efeefb8

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Metal
22

3-
Prototype compiled language built in Rust with LLVM.
3+
A prototype compiled programming language, striving to be an easy-to-use, borrow checked, non-garbage-collected,
4+
memory safe, robust programming language.
45

56
## Contributing
67

@@ -10,8 +11,12 @@ opening an issue, or [joining our Discord](https://discord.gg/fDCMSbgpsB) and sa
1011

1112
## Development
1213

13-
Use nightly Rust.
14+
### Rust
1415

15-
If you want to add a dependency, add it to the workspace Cargo.toml and then
16-
in the crate that you want to use this dependency in specify that dependency as `dep_name = { workspace = true }`.
17-
This makes updating deps much easier.
16+
The Metal toolchain uses the nightly Rust channel, so to work on it you should use a reasonably recent nightly Rust installation.
17+
18+
#### Adding Dependencies
19+
20+
When adding dependencies to Metal please make sure to only add the main dependency information (i.e. `tokio = { version = "1", features = ["full"] }`)
21+
to the `Cargo.toml` in Metal's root directory. Then, when using the dependency in one of Metal's child crates, in lieu of adding it directly, only add it
22+
as a workspace dependency (i.e. `tokio = { workspace = true }`).

0 commit comments

Comments
 (0)