Skip to content

Commit dcb6ad3

Browse files
committed
Add development instructions to the README
1 parent 55eb678 commit dcb6ad3

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,35 @@
22

33
This repository hosts [The F# Software Foundation web site](https://fsharp.org/). Pull requests are welcome. The web site code is hosted in the `gh-pages` branch and is created using the tools provided by GitHub:
44

5-
* Switch to [the `gh-pages` branch](https://github.com/fsharp/fsharp.org/tree/gh-pages)
6-
* Read [documentation for Github Pages](https://help.github.com/categories/20/articles)
7-
* The site is using [Jekyll for templating](http://jekyllrb.com/docs/usage/)
5+
* Switch to [the `gh-pages` branch](https://github.com/fsharp/fsharp.org/tree/gh-pages)
6+
* Read [documentation for Github Pages](https://help.github.com/categories/20/articles)
7+
* The site is using [Jekyll for templating](http://jekyllrb.com/docs/usage/)
88

9+
## Development
910

11+
The easiest way to get started with this repository is by using the supplied dev container.
12+
13+
### Using the Dev Container
14+
15+
1. Open the repository in Visual Studio Code.
16+
2. When prompted, reopen the repository in the dev container.
17+
3. The dev container will automatically set up the development environment.
18+
19+
**Summary of using a dev container:**
20+
A dev container is a pre-configured development environment that includes all the necessary tools and dependencies. It allows you to start developing without having to manually set up your environment.
21+
22+
If not using VSCode, consult your preferred IDE's documentation for instructions.
23+
24+
To start the development server, run the following command:
25+
26+
```sh
27+
bundle exec jekyll serve
28+
```
29+
30+
Or, to enable live reloading:
31+
32+
```sh
33+
bundle exec jekyll serve -l
34+
```
35+
36+
The site will be available at `http://localhost:4000`

0 commit comments

Comments
 (0)