Skip to content

Commit c22d2c2

Browse files
committed
Update README.md.
1 parent 3bbc5ec commit c22d2c2

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

README.md

+8-15
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Robolectric
22

3-
[![Build Status](https://secure.travis-ci.org/robolectric/robolectric.github.io.png?branch=source)](http://travis-ci.org/robolectric/robolectric.github.io)
3+
[![Build Status](https://secure.travis-ci.org/robolectric/robolectric.github.io.png?branch=master)](http://travis-ci.org/robolectric/robolectric.github.io)
44

55
This repository is the source for the docs that live at [robolectric.org](http://robolectric.org).
66

77
## Contributing
88

9-
Make sure you are in the `source` branch before making changes. This is the default branch so git should put you there automatically.
9+
Make sure you are in the `master` branch before making changes. This is the default branch so git should put you there automatically.
1010

11-
Before submitting a pull request, view the docs locally to check that the content and layout are correct. The docs are built using [middleman](https://github.com/middleman/middleman).
11+
Before submitting a pull request, view the docs locally to check that the content and layout are correct. The docs are built using [jekyll](https://jekyllrb.com/).
1212

1313
Assuming you don't already have [Bundler](http://bundler.io/) installed, you will first need to do:
1414

@@ -19,20 +19,13 @@ The above command may require `sudo`.
1919
Then run:
2020

2121
bundle install
22-
bundle exec middleman server
22+
bundle exec jekyll server
2323

24-
This will build the docs and make them available at [localhost:4567](http://localhost:4567). Once
25-
your pull request is accepted, the docs will be automatically built and pushed to the web by
26-
Travis CI.
24+
This will build the docs and make them available at [localhost:4000](http://localhost:4000). Once
25+
your pull request is accepted, the docs will be automatically built and pushed to the web by GitHub.
2726

2827
## Javadocs
2928

30-
When Robolectric is released, the `source/javadocs` directory needs to be updated. This can be done by grabbing the javadocs that were pushed to [Maven Central](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.robolectric%22%20AND%20a%3A%22robolectric%22) and unjarring them into that directory.
31-
32-
## Gory Details: How These Docs Get Published
33-
34-
This repository has 2 branches: `source` and `master`. The former is a middleman project that can generate the latter. With every commit that is made to the `source` branch, Travis CI runs middleman and deploys the results back to the `master` branch. It does this by using an OAUTH token belonging to the robolectric-travis-bot user, who only has permission to commit and push to this repository.
35-
36-
37-
29+
When Robolectric is released, the `source/javadocs` directory needs to be updated. They can be generated with:
3830

31+
./gradlew aggregateJavadocs

0 commit comments

Comments
 (0)