Skip to content

Commit d49e4c9

Browse files
committed
Update README with build instructions
1 parent c7d2209 commit d49e4c9

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,31 @@
11
# biojava.github.io
2-
The new location of the [BioJava homepage](http://biojava.github.io)
2+
The new location of the BioJava homepage, accessible at either http://biojava.org or http://biojava.github.io.
33

4-
## Conversion from Mediawiki
4+
## Running Locally
5+
6+
The website uses [Jekyll](https://jekyllrb.com/) to generate static HTML content from Markdown. This is done automatically for the master branch of github.com/biojava/biojava.github.io, but can also be run locally for testing.
7+
8+
### Installation
9+
10+
Compiling the site locally requires ruby. Install the following gems:
11+
12+
```
13+
gem install github-pages
14+
```
515

6-
Following @peterjc 's instructions how to convert from mediawiki to markdown
16+
The `github-pages` plugin bundles all gems required for hosting, including the jekyll executable. You can immediately start a server for the content with
717

8-
https://github.com/peterjc/mediawiki_to_git_md
18+
```
19+
jekyll serve --incremental
20+
```
21+
22+
Note that we aren't yet using bundler ([recommended by github](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#keeping-your-site-up-to-date-with-the-github-pages-gem)), but this would be a nice feature to configure.
23+
24+
## Conversion from Mediawiki
25+
26+
All content was ported from the prior BioJava wiki following @peterjc 's [instructions and scripts](https://github.com/peterjc/mediawiki_to_git_md).
927

1028
## Template
1129

12-
[HTML5 UP](http://html5up.net)
30+
We use the [HTML5 UP](http://html5up.net) template.
31+

0 commit comments

Comments
 (0)