diff --git a/CHARTER.md b/CHARTER.md index e0b3180..8615ac7 100644 --- a/CHARTER.md +++ b/CHARTER.md @@ -1,32 +1,17 @@ -# {{GROUP_NAME}} Charter - +# Const Generics Charter -## Goals - - +The goal of this group is to both improve and extend the support for const generics. -## Constraints And Considerations +## Goals - +Improving the user experience when using and working on const generics. This includes both improvements to diagnostics for the already stabilized parts as well as adding new features: +- const param defaults `struct Foo` +- more const param types, most importantly user defined types and `&'static str` +- allowing complex generic operations in constants -## Membership +## Constraints And Considerations - +At least for the near future, we will mostly focus on the items mentioned above. -**Shepherd:** -**Team Liason:** -**Members:** + diff --git a/README.md b/README.md index 93f16d7..9ac2f77 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,4 @@ -# {{GROUP_NAME}} {{GROUP_TYPE}} Group - +# Const Generics Project Group ![project group status: active](https://img.shields.io/badge/status-active-brightgreen.svg) + +The const generics project group implements and designs the `const_generics` feature. Please refer to our [charter] for more information on our goals and current scope. + +Examples: + +```rust +struct Foo { + field: [u8; N], +} + +fn foo() -> Foo { + Foo { + field: [0; N], + } +} + +fn main() { + match foo::<3>().field { + [0, 0, 0] => {} // ok + [_x, _y, _z] => panic!(), + } +} +``` +FIXME(website): do we want a website for this? -Welcome to the repository for the {{GROUP_NAME}} Project Group! This is the +Welcome to the repository for the Const Generics Project Group! This is the repository we use to organise our work. Please refer to our [charter] as well as our [github pages website][gh-pages] for more information on our goals and current scope. - -[charter]: ./CHARTER.md [gh-pages]: https://rust-lang.github.io/{{GROUP_SLUG}} -**/FIX ME** +**/FIX ME** +--> -## How Can I Get Involved? +[charter]: ./CHARTER.md -**FIX ME** - +## How Can I Get Involved? [You can find a list of the current members available on `rust-lang/team`.][team-toml] -If you'd like to participate be sure to check out any of our [open issues] on this -repository. - -We also participate on [{{CHAT_PLATFORM}}][chat-link], feel free to introduce +If you'd like to participate be sure to check out the relevant stream on [zulip][chat-link], feel free to introduce yourself over there and ask us any questions you have. - [open issues]: /issues -[chat-link]: {{CHAT_LINK}} -[team-toml]: https://github.com/rust-lang/team/blob/master/teams/{{GROUP_TYPE}}-{{GROUP_SLUG}}.toml - -**/FIX ME** +[chat-link]: https://rust-lang.zulipchat.com/#narrow/stream/260443-project-const-generics +[team-toml]: https://github.com/rust-lang/team/blob/master/teams/project-const-generics.toml ## Building Documentation This repository is also an mdbook project. You can view and build it using the