Skip to content

Commit 8eb823f

Browse files
committed
Update README.md
1 parent 96e9e0b commit 8eb823f

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,65 @@
11
# README
22

3-
N.b. see [./al-folio.README.md](./al-folio.README.md) for the original forked README from the Jekyll Al-Folio theme.
3+
(by Alex, Cesare)
44

5+
**NB:** see [./al-folio.README.md](./al-folio.README.md) for the original forked README from the Jekyll Al-Folio theme.
56

67
## Setting up your local
7-
I highly suggest you use docker-compose. See [./al-folio.README.md](./al-folio.README.md) for further instructions. You should end up in a scenario where booting your local requires only that you issue the command
88

9-
```
9+
We highly suggest you use docker-compose. See [./al-folio.README.md](./al-folio.README.md) for further instructions. You should end up in a scenario where booting your local requires only that you issue the command
10+
11+
```shell
1012
docker-compose up
1113
```
1214

13-
Your local will be at http://0.0.0.0:8080; most people (like myself) like to rename this address in the local hosts file. That is, add the following to `/etc/hosts/` on Ubuntu, `/private/etc/hosts/` on mac, or `C:\Windows\System32\drivers\etc\hosts` on Windows.
15+
Your local will be at http://0.0.0.0:8080; most people (like Alex) like to rename this address in the local hosts file. That is, add the following to `/etc/hosts/` on Ubuntu, `/private/etc/hosts/` on mac, or `C:\Windows\System32\drivers\etc\hosts` on Windows.
1416

1517
```
1618
0.0.0.0 clc
1719
```
1820

1921
This makes http://clc:8080 access http://0.0.0.0:8080.
2022

21-
2223
## How to Jekyll
24+
2325
[Read the docs](https://jekyllrb.com/docs/). This [step by step guide](https://jekyllrb.com/docs/step-by-step/01-setup/) has most of what you need to know; read, in particular, the pages on layouts, includes, and collections.
2426

2527
## Contribution & to-do's
2628

2729
### Editing the homepage
2830

29-
Just edit [_pages/about.md](_pages/about.md). **I am not a CSS or SASS expert.** I leave the styling of the homepage up to whomever would like to change it.
31+
Just edit [_pages/about.md](_pages/about.md). **We are not CSS or SASS experts.** We leave the styling of the homepage up to whomever would like to change it.
3032

3133
### Editing the styling
3234

33-
Garrett mentioned this resource from UI on [how to style like a UI site](https://uids.brand.uiowa.edu/?path=/docs/components-alert--docs). If anyone wants to tackle that, good luck!
35+
Garrett mentioned this resource from UI on [how to style like a UI site](https://uids.brand.uiowa.edu/?path=/docs/components-alert--docs). If anyone wants to tackle that, good luck!
3436

3537
### Editing members
36-
Go to [_members](./_members).
3738

38-
- If you are a graduate student, copy [alex.md](./_members/alex.md) to `yourname.md`.
39+
Go to [_members](./_members).
40+
41+
- If you are a graduate student, copy [alex.md](./_members/alex.md) to `yourname.md`.
3942
- If you are a professor, copy [garrett.md](./_members/garrett.md) to `yourname.md`.
40-
- If you are a post-doc / research scientist, [andrew.md](./_members/andrew.md) to `yourname.md`.
43+
- If you are a research scientist, [daniel.md](./_members/daniel.md) to `yourname.md`.
44+
- If you are a post-doc, [andrew.md](./_members/andrew.md) to `yourname.md`.
4145

4246
**Do not edit the _role_ field**. Otherwise, change the metadata appropriately. **Add a picture of yourself to [./assets/img/](./assets/img/); make sure the name of the photo you add agrees with the name in your markdown file.
4347

44-
45-
**I expect you to add your own member entry. -@ahubers**
46-
4748
### Editing projects and linked repositories
4849

50+
[Currently inactive]
4951
Edit [_pages/projects.md](./_pages/projects.md) to change the copy on the **projects** pages. Edit the `artifacts` entry in [_data/repositories.yml](_data/repositories.yml) to change the "popular repositories" entries on the projects page.
5052

5153
### Editing recent publications
5254

53-
Add an entry to [_bibliography/papers.bib](_bibliography/papers.bib). N.b. If you want to add a photo with your publication, change the "preview" entry in [_bibliography/papers.bib](_bibliography/papers.bib) to the name of an image located at [assets/img](./assets/img).
55+
Add an entry to [_bibliography/papers.bib](_bibliography/papers.bib).
56+
57+
**NB:** If you want to add a photo with your publication, change the "preview" entry in [_bibliography/papers.bib](_bibliography/papers.bib) to the name of an image located at [assets/img](./assets/img).
58+
59+
### Editing news
5460

55-
### Editing news / announcements
61+
Add a item to as a single markdown file to [_news/](./_news). See the files already in their for the expected format.
5662

57-
I don't have this set up quite yet. Please advise on if we want it, for what we would use it (if so), and how it should appear on the site.
63+
### Editing announcements
5864

65+
We don't have this set up quite yet. Please advise on if we want it, for what we would use it (if so), and how it should appear on the site.

0 commit comments

Comments
 (0)