Merge pull request #1 from lcnr/initial

initial group description

Author: oli-obk

CHARTER.md

@@ -1,32 +1,17 @@
-# {{GROUP_NAME}} Charter
-<!--
- Provide an introduction summarising the goals and motivation behind your
- project group.
--->
+# Const Generics Charter
 
-## Goals
-
-<!--
- Explain what changes you'd like to see your group your group to focus on, and
- how you plan to approach these issues. Focus on explaining the highest possible
- level of your change.
--->
+The goal of this group is to both improve and extend the support for const generics.
 
-## Constraints And Considerations
+## Goals
 
-<!--
- Explain the scope of your group, what you have chosen not to include in
- your goals, and your motivations behind making them non-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<const N: usize = 3>`
+- more const param types, most importantly user defined types and `&'static str`
+- allowing complex generic operations in constants
 
-## Membership
+## Constraints And Considerations
 
-<!--
- Mention your initial membership and who has decided take the roles of
- shepherd(s) and liason.
--->
+At least for the near future, we will mostly focus on the items mentioned above.
 
-**Shepherd:**
-**Team Liason:**
-**Members:**
+<!-- Why not just do everything, it's not like burnout is a problem in open source -->

README.md

@@ -1,78 +1,65 @@
-# {{GROUP_NAME}} {{GROUP_TYPE}} Group
-<!--
- This is the template for creating project groups in rust-lang. Be sure to go
- through all sections marked with `**FIX ME**`, and make sure that the text is
- correct, and feel free to replace/remove any part that's not relevant to
- your group.
-
- All of the text across all of the initial files uses the same group of
- variables to allow for easy search and replace. They are listed below.
-
- Example sed command: `sed -i '' 's/{{GROUP_NAME}}/Inline ASM/g' ./**/*.md`
- *Note* the `-i ''` is important as it is required on some platforms e.g. macOS
-
- * {{GROUP_NAME}} -> The display name of your group e.g. "Inline ASM".
- * {{GROUP_SLUG}} -> The url slug name of your group used for
-   `rust-lang/team` and repo name. e.g. "pg-inline-asm".
- * {{CHAT_PLATFORM}} -> The name of your chat app e.g. "Zulip".
- * {{CHAT_LINK}} -> The hyperlink to your discussions on the chat app
-   e.g. "https://rust-lang.zulipchat.com/#narrow/stream/216763-project-inline-asm".
--->
+# Const Generics Project Group
 
 <!--
  Status badge advertising the project as being actively worked on. When the
  project has finished be sure to replace the active badge with a badge
  like: https://img.shields.io/badge/status-archived-grey.svg
 -->
 ![project group status: active](https://img.shields.io/badge/status-active-brightgreen.svg)
+<!--
+FIXME(website)
 [![project group documentation](https://img.shields.io/badge/MDBook-View%20Documentation-blue)][gh-pages]
-
-
-**FIX ME**
+-->
+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<const N: usize> {
+    field: [u8; N],
+}
+
+fn foo<const N: usize>() -> Foo<N> {
+    Foo {
+        field: [0; N],
+    }
+}
+
+fn main() {
+    match foo::<3>().field {
+        [0, 0, 0] => {} // ok
+        [_x, _y, _z] => panic!(),
+    }
+}
+```
 
 <!--
- Provide a short introduction about your project group. Make sure to include any
- relevant links to information about your group.
--->
+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**
 
-<!--
- List ways that people from outside your group can get involved and potentially
- become members, include what meetings your team has, and how a person could
- start participating and contributing. Make sure to mention the main platform
- your group hosts its discussions. Be sure to also include links to any
- other projects that your group maintains.
--->
+## 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