|
1 |
| -# {{GROUP_NAME}} {{GROUP_TYPE}} Group |
2 |
| -<!-- |
3 |
| - This is the template for creating project groups in rust-lang. Be sure to go |
4 |
| - through all sections marked with `**FIX ME**`, and make sure that the text is |
5 |
| - correct, and feel free to replace/remove any part that's not relevant to |
6 |
| - your group. |
7 |
| -
|
8 |
| - All of the text across all of the initial files uses the same group of |
9 |
| - variables to allow for easy search and replace. They are listed below. |
10 |
| -
|
11 |
| - Example sed command: `sed -i '' 's/{{GROUP_NAME}}/Inline ASM/g' ./**/*.md` |
12 |
| - *Note* the `-i ''` is important as it is required on some platforms e.g. macOS |
13 |
| -
|
14 |
| - * {{GROUP_NAME}} -> The display name of your group e.g. "Inline ASM". |
15 |
| - * {{GROUP_SLUG}} -> The url slug name of your group used for |
16 |
| - `rust-lang/team` and repo name. e.g. "pg-inline-asm". |
17 |
| - * {{CHAT_PLATFORM}} -> The name of your chat app e.g. "Zulip". |
18 |
| - * {{CHAT_LINK}} -> The hyperlink to your discussions on the chat app |
19 |
| - e.g. "https://rust-lang.zulipchat.com/#narrow/stream/216763-project-inline-asm". |
20 |
| ---> |
| 1 | +# Stable MIR Librarification Project Group |
21 | 2 |
|
22 | 3 | <!--
|
23 | 4 | Status badge advertising the project as being actively worked on. When the
|
|
28 | 9 | [][gh-pages]
|
29 | 10 |
|
30 | 11 |
|
31 |
| -**FIX ME** |
32 |
| - |
33 | 12 | <!--
|
34 | 13 | Provide a short introduction about your project group. Make sure to include any
|
35 | 14 | relevant links to information about your group.
|
36 | 15 | -->
|
37 | 16 |
|
38 |
| -Welcome to the repository for the {{GROUP_NAME}} Project Group! This is the |
39 |
| -repository we use to organise our work. Please refer to our [charter] as well |
| 17 | +Welcome to the repository for the Stable MIR Librarification Project Group! Our goal is to provide a stable |
| 18 | +API based on the rust compiler mid-level intermediate representation (MIR) that can be used as the foundation |
| 19 | +for development of tools that want to perform sophisticated analyses and make stronger guarantees about the |
| 20 | +behavior of Rust programs. |
| 21 | + |
| 22 | + |
| 23 | +This is the repository we use to organise our work. Please refer to our [charter] as well |
40 | 24 | as our [github pages website][gh-pages] for more information on our goals and
|
41 | 25 | current scope.
|
42 | 26 |
|
43 | 27 | [charter]: ./CHARTER.md
|
44 |
| -[gh-pages]: https://rust-lang.github.io/{{GROUP_SLUG}} |
45 |
| - |
46 |
| -**/FIX ME** |
| 28 | +[gh-pages]: https://rust-lang.github.io/project-stable-mir |
47 | 29 |
|
48 | 30 |
|
49 | 31 | ## How Can I Get Involved?
|
50 | 32 |
|
51 |
| -**FIX ME** |
52 |
| - |
53 |
| -<!-- |
54 |
| - List ways that people from outside your group can get involved and potentially |
55 |
| - become members, include what meetings your team has, and how a person could |
56 |
| - start participating and contributing. Make sure to mention the main platform |
57 |
| - your group hosts its discussions. Be sure to also include links to any |
58 |
| - other projects that your group maintains. |
59 |
| ---> |
60 | 33 |
|
61 | 34 | [You can find a list of the current members available
|
62 | 35 | on `rust-lang/team`.][team-toml]
|
63 | 36 |
|
64 | 37 | If you'd like to participate be sure to check out any of our [open issues] on this
|
65 | 38 | repository.
|
66 | 39 |
|
67 |
| -We also participate on [{{CHAT_PLATFORM}}][chat-link], feel free to introduce |
| 40 | +We also participate on [Zulip][chat-link], feel free to introduce |
68 | 41 | yourself over there and ask us any questions you have.
|
69 | 42 |
|
70 | 43 |
|
71 | 44 | [open issues]: /issues
|
72 |
| -[chat-link]: {{CHAT_LINK}} |
73 |
| -[team-toml]: https://github.com/rust-lang/team/blob/master/teams/{{GROUP_TYPE}}-{{GROUP_SLUG}}.toml |
74 |
| - |
75 |
| -**/FIX ME** |
76 |
| - |
77 |
| -## Building Documentation |
78 |
| -This repository is also an mdbook project. You can view and build it using the |
79 |
| -following command. |
| 45 | +[chat-link]: https://rust-lang.zulipchat.com/#narrow/stream/320896-project-stable-mir |
| 46 | +[team-toml]: https://github.com/rust-lang/team/blob/master/teams/project-stable-mir.toml |
80 | 47 |
|
81 |
| -``` |
82 |
| -mdbook serve |
83 |
| -``` |
0 commit comments