You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28Lines changed: 28 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,3 +80,31 @@ thorugh the build process in two easy steps:
80
80
Which will make the `rules.adoc` file (in the current working directory --
81
81
that's the `$(pwd)` part) go through the build steps above and generate files
82
82
`rules.html` and `rules.pdf` as a result.
83
+
84
+
## Use GitHub Codespaces to edit these files
85
+
86
+
GitHub now has a nice service called [Codespaces](https://github.com/features/codespaces)
87
+
which allows us to spin up a "development environment" without having to
88
+
install various dependencies without having to leave the web browser.
89
+
90
+
Here is a short tutorial on how to edit the rules in Codespaces.
91
+
92
+
### Spinning up Codespaces and building the rules
93
+
94
+
1. First, navigate to the top part of the repository.
95
+
96
+
2. Click on **Code** and then on **Create codespace on master**
97
+

98
+
99
+
3. You should now be able to navigate the `rules.adoc` and/or `superteam_rules.adoc` files and edit them as you like.
100
+
101
+
4. To actually build rules as a PDF and/or HTML, you can execute the following:
102
+
103
+
./scripts/build-rules.bash rules
104
+
105
+
5. After the script has ran, you will see lines such as the following in the output:
106
+
107
+
See the HTML version at: http://localhost:12345/tmp_rules.html
108
+
See the PDF version at: http://localhost:12345/tmp_rules.pdf
109
+
110
+
Clicking on either should bring you to a directory listing, in which you can find `tmp_rules.html` and `tmp_rules.pdf` and have them load. Note that this is now being served from the Codespaces environment (the actual URL will have the `app.github.dev` suffix).
0 commit comments