Skip to content

Commit e0d02cc

Browse files
authored
Fill in the repository template gaps (#1)
1 parent 9599a3a commit e0d02cc

File tree

2 files changed

+13
-49
lines changed

2 files changed

+13
-49
lines changed

CHARTER.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# {{GROUP_NAME}} Charter
1+
# Stable MIR Librarification Charter
22
<!--
33
Provide an introduction summarising the goals and motivation behind your
44
project group.

README.md

Lines changed: 12 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,4 @@
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
212

223
<!--
234
Status badge advertising the project as being actively worked on. When the
@@ -28,56 +9,39 @@
289
[![project group documentation](https://img.shields.io/badge/MDBook-View%20Documentation-blue)][gh-pages]
2910

3011

31-
**FIX ME**
32-
3312
<!--
3413
Provide a short introduction about your project group. Make sure to include any
3514
relevant links to information about your group.
3615
-->
3716

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
4024
as our [github pages website][gh-pages] for more information on our goals and
4125
current scope.
4226

4327
[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
4729

4830

4931
## How Can I Get Involved?
5032

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-
-->
6033

6134
[You can find a list of the current members available
6235
on `rust-lang/team`.][team-toml]
6336

6437
If you'd like to participate be sure to check out any of our [open issues] on this
6538
repository.
6639

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
6841
yourself over there and ask us any questions you have.
6942

7043

7144
[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
8047

81-
```
82-
mdbook serve
83-
```

0 commit comments

Comments
 (0)