Skip to content

Commit 9a38854

Browse files
authored
Merge pull request #42 from mit-acl/aneesas-readme-patch
Cleaning up README
2 parents 13b2773 + 4277166 commit 9a38854

1 file changed

Lines changed: 5 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ cd mit-acl.github.io
1212

1313
## Running it locally
1414

15-
You only need **Docker** installed (no Node.js, no Ruby). Then:
15+
You only need **Docker** installed. Then:
1616

1717
```bash
1818
./serve.sh # live preview at http://localhost:4321 (auto-reloads as you edit)
@@ -29,7 +29,7 @@ The first run builds the Docker image (~30s); after that it starts in a few seco
2929
3030
## Deploying
3131

32-
Pushing to `main` deploys automatically: the [Deploy to GitHub Pages](.github/workflows/deploy.yml)
32+
Open a PR to deploy any website changes. When your PR is approved and merged into `main`, it will deploy automatically: the [Deploy to GitHub Pages](.github/workflows/deploy.yml)
3333
workflow builds the site and publishes it. Check its progress
3434
[here](https://github.com/mit-acl/mit-acl.github.io/actions). To redeploy without a code change,
3535
run the workflow manually from the Actions tab.
@@ -56,7 +56,7 @@ Images and other files go under `public/` and are linked without the `public` pr
5656
### Publications
5757

5858
All ACL publications live in [`bibliography/ACL_Publications.bib`](bibliography/ACL_Publications.bib)
59-
(formerly the separate `mit-acl/bibliography` repo, merged here with its history). Add or fix entries
59+
(formerly the separate `mit-acl/bibliography` repo). Add or fix entries
6060
there and the Publications page rebuilds from it; see [`bibliography/README.md`](bibliography/README.md)
6161
for the validation and merge scripts. The dev server reads the file once at startup, so restart it
6262
(`./serve.sh stop && ./serve.sh`) to see bibliography edits.
@@ -66,12 +66,9 @@ under `papers:` in the front matter.
6666

6767
## New Students
6868

69-
If you're a new student, you need to be added to the website.
70-
Reach out to the [current ACL webmaster](https://wikis.mit.edu/confluence/pages/viewpage.action?pageId=123502773) via Slack and provide the following:
69+
If you're a new student, you need to be added to the website. You can do this via a PR that adds:
7170
1. A headshot (i.e. `.jpg` or `.png`)
72-
2. Markdown providing your information. [(See this example.)](howto/template_member.md)
73-
74-
Alternatively, if you're comfortable with GitHub, you're welcome to make the changes yourself and submit a pull request.
71+
2. Markdown providing your information [(See this example.)](howto/template_member.md)
7572

7673
## How it's organized
7774

@@ -91,5 +88,4 @@ bibliography/ ACL_Publications.bib, the AIAA citation style, and helper sc
9188

9289
## Notes
9390

94-
* Derived from [the old private website repo](https://github.com/mit-acl/website). (Didn't fork because of the LFS files committed directly to the old repo.)
9591
* The visual theme is "Index" by JekyllThemes.io; see [`_LICENSE.md`](_LICENSE.md).

0 commit comments

Comments
 (0)