Skip to content

Commit 8e9123f

Browse files
author
Nicolai Parlog
committed
Clarify that no submodules are used
1 parent ca64796 commit 8e9123f

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@ site/
22
site-source/
33
.gradle/
44
junit-pioneer/
5+
junit-pioneer
56

67
deploy-key

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,17 @@ Acceptable version ranges were not thoroughly tested - these versions were used
1919

2020
This repository consists of three branches:
2121

22-
* `grandmaster`: contains all branches (as [worktrees][git-worktree]) and projects (as [submodules][git-submodule] - it is the default branch)
22+
* `grandmaster`: contains all branches (as [worktrees][git-worktree]) and projects (as clones or symlinks)
2323
* `master`: the HTML content hosted under [junit-pioneer.org](http://junit-pioneer.org) as required by [GitHub organization pages][gh-org-pages]
2424
* `site-source`: the site in source form without project-specific content
2525

2626
The directory structure in `grandmaster` must be as follows:
2727

2828
* `site`: worktree of branch `master`
2929
* `site-source`: worktree of branch `site-source`
30-
* `junit-pioneer`: `master` branch of [JUnit Pioneer][Pioneer]
30+
* `junit-pioneer`: `master` branch of [JUnit Pioneer][Pioneer] (cloned here specifically for site-building or as symlink to existing clone)
3131

3232
[git-worktree]: https://git-scm.com/docs/git-worktree
33-
[git-submodule]: https://git-scm.com/docs/git-submodule
3433
[gh-org-pages]: https://help.github.com/articles/user-organization-and-project-pages/#user--organization-pages
3534

3635

@@ -39,7 +38,7 @@ The directory structure in `grandmaster` must be as follows:
3938
Besides creating the correct folder structure, `bundle install` must be executed in `site-source` to initialize Jekyll.
4039

4140
If you're on Linux, all of this can be done by calling `gradle setup`.
42-
On Windows, you may have to run `git-setup.sh` (these are all Git commands) and then `bundle install` in `site-source`.
41+
On Windows, you may have to run `git-repo-setup.sh` (these are all Git commands) and then `bundle install` in `site-source`.
4342

4443

4544
## Site-Building

0 commit comments

Comments
 (0)