Skip to content

Commit 089aff8

Browse files
committed
fix readme
1 parent 631a396 commit 089aff8

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

README.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,34 @@
77
~/your-org.github.io$ git push
88
```
99

10+
You'll probably need to resolve merge conflicts after you do `git pull`.
11+
1012
## Creating new badgeboard:
1113

14+
1\. clone this repo
15+
1216
```sh
1317
~$ git clone https://github.com/repo-utils/badgeboard.git your-org.github.io
1418
```
1519

16-
Change:
17-
18-
- src/maintainers.json
19-
- src/projects.json
20-
- .gitignore (unignore autogenerated files)
21-
22-
Make it:
20+
2\. change `config.yaml`
21+
3\. change `.gitignore`, unignore autogenerated files, see comments there
22+
4\. make it:
2323

2424
```
25-
~/your-org.github.io$ make db
2625
~/your-org.github.io$ make
27-
~/your-org.github.io$ git add src/db.json index.html
28-
~/your-org.github.io$ git commit src/db.json index.html -m 'rebuild'
2926
```
3027

31-
Test it:
28+
5\. test it:
3229

3330
```
3431
~/your-org.github.io$ firefox index.html
3532
```
3633

34+
6\. add autogenerated files so they will appear on github pages:
35+
36+
```
37+
~/your-org.github.io$ git add src/db.json index.html
38+
~/your-org.github.io$ git commit src/db.json index.html -m 'rebuild'
39+
```
40+

0 commit comments

Comments
 (0)