Skip to content

Commit 0439bc0

Browse files
committed
add a basic readme
1 parent 9507636 commit 0439bc0

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# ddnet-web
2+
3+
## Cloning
4+
5+
To clone this repository with full history (~350 MiB):
6+
7+
```bash
8+
git clone https://github.com/ddnet/ddnet-web
9+
```
10+
11+
## Dependencies
12+
13+
The website uses [Ruby](https://www.ruby-lang.org) with [Jekyll](https://jekyllrb.com) static site generator.
14+
15+
Follow the official installation guide for Ruby [here](https://www.ruby-lang.org/en/documentation/installation).
16+
17+
After that, install Jekyll:
18+
19+
```
20+
gem install bundler jekyll
21+
```
22+
23+
Navigate to the directory and start the local server:
24+
25+
```
26+
cd www
27+
jekyll serve
28+
```
29+
30+
By default, the website will be served on http://127.0.0.1:4000.
31+
32+
Note: Many pages will not work locally because they require PHP or must be built using specific scripts from the [ddnet-scripts](https://github.com/ddnet/ddnet-scripts) repository.

0 commit comments

Comments
 (0)