Skip to content

Commit 522ddbf

Browse files
authored
Update README.md
1 parent 5f14950 commit 522ddbf

File tree

1 file changed

+4
-25
lines changed

1 file changed

+4
-25
lines changed

README.md

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ kurtz_prentice_fricra24:
4646
year: 2024
4747
```
4848

49-
Note: The authors, links, title, and year are used to automatically make the entry/text/links on the publications page of the website. The raw_string is what is displayed in the 'BibTex' dropdown on the publications page. Add all additional information (e.g. organization, etc) to the raw_string param, not in the main yaml entry; otherwise, it will not be included in the bibtex entry (and the website currently does not support including other information on the main publications page).
49+
Note: The authors, links, title, and year are used to automatically make the entry/text/links on the publications page of the website. The raw_string is what is displayed in the 'BibTex' dropdown on the publications page. Add all additional information (e.g. organization, etc) to the raw_string param, not in the main yaml entry; otherwise, it will not be included in the bibtex entry (and the website currently does not support including other information on the main publications page). This is because our citations have not been formatted consistently over the last 20+ years...
5050

5151
# To add a research project to the website:
5252
Create a new markdown file in this directory: robustrobotics.github.io/_projects with the same structure as the other files in the directory. After committing the change, the project will automatically be added to the website. Note that you can archive projects (remove them from the home page and add them to the 'Past Projects' section of the Research page) using the 'status: inactive' flag in the project .md.
5353

5454
# To add a news item to the website:
5555
Create a new markdown file in this directory: robustrobotics.github.io/_posts. Note that the first part of the name of the file should be the date of the post.
5656

57-
Research Group Web Site Template
57+
This site is based on the Research Group Web Site Template, and uses bibere as a publications manager.
5858
================================
5959

6060
This is a [Jekyll][]-based Web site intended for research groups. Your group should be able to get up and running with minimal fuss.
@@ -92,7 +92,6 @@ Setup
9292
3. Clone the fork to your own machine: `git clone [email protected]:yourgroup/research-group-web.git`.
9393
4. Add an "upstream" remote for the original repository so you can stay abreast of bugfixes: `git remote add upstream https://github.com/uwsampa/research-group-web.git`.
9494
5. Customize. Start with the `_config.yml` file, where you enter the name of the site and its URL.
95-
6. Type `make` to build the site and then run `make serve` to view your site.
9695
7. Keep adding content. See below for instructions for each of the various sections.
9796
8. Periodically pull from the upstream repository: `git pull upstream master`.
9897

@@ -103,8 +102,7 @@ Setup
103102
Publication List
104103
----------------
105104

106-
The list of publications is in `bib/pubs.bib`. Typing `make` will generate `pubs.html`, which contains a pretty, sorted HTML-formatted list of papers. The public page, `publications.html`, also has a link to download the original BibTeX.
107-
105+
The publications list uses bibere, (https://github.com/ucinlp/bibere/tree/master), a Jekyll-only publications manager, to enable publications updating by editing only .yaml files. See more info on their webpage.
108106

109107
News Items and Blog Posts
110108
-------------------------
@@ -159,23 +157,4 @@ People are listed in a [YAML][] file in `_data/people.yml`. You can list the nam
159157
Building
160158
--------
161159

162-
The requirements for building the site are:
163-
164-
* [Jekyll][]: run `gem install jekyll`
165-
* [bibble][]: available on `pip`
166-
* ssh and rsync, only if you want to deploy directly.
167-
168-
`make` compiles the bibliography and the website content to the `_site`
169-
directory. To preview the site, run `jekyll serve`` and head to
170-
http://0.0.0.0:5000.
171-
172-
173-
Deploying to Your Sever
174-
-----------------------
175-
176-
To set up deployments, edit the Makefile and look for the lines where `HOST` and `DIR` are defined. Change these to the host where your HTML files should be copied to.
177-
178-
To upload a new version of the site via rsync over ssh, type `make deploy`. A web hook does this automatically when you push to GitHub. Be aware that the Makefile is configured to have rsync delete stray files from the destination directory.
179-
180-
[Jekyll]: http://jekyllrb.com/
181-
[bibble]: https://github.com/sampsyo/bibble/
160+
The website is built entirely using Jekyll with github actions. It is automatically rebuilt every time that you generate a commit.

0 commit comments

Comments
 (0)