Skip to content

Commit 2269b9f

Browse files
committed
add README
1 parent 1f7dfb7 commit 2269b9f

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# The Rust blog
2+
3+
[![Build Status](https://travis-ci.org/rust-lang/blog.rust-lang.org.svg?branch=master)](https://travis-ci.org/rust-lang/blog.rust-lang.org)
4+
5+
This is the blog of the Rust Programming Language.
6+
7+
It's implemented as a small static site generator, that's deployed to GitHub
8+
Pages via Travis.
9+
10+
## Building
11+
12+
To build the site locally:
13+
14+
```console
15+
> git clone https://github.com/rust-lang/blog.rust-lang.org
16+
> cd blog.rust-lang.org
17+
> cargo run
18+
```
19+
20+
You could do it in release mode if you'd like, but it's pretty fast in debug.
21+
22+
From there, the generated HTML will be in a `site` directory. You can use
23+
any web server to check it out in your browser:
24+
25+
```console
26+
> cd site
27+
> python -m SimpleHTTPServer
28+
```
29+
30+
The site is now available at <0.0.0.0:8000>.
31+
32+
## Contributing
33+
34+
First of all, thank you!
35+
36+
Like everything in Rust, the blog is licensed MIT/Apache 2.0. See the two
37+
`LICENSE-*` files for more details. We're also governed by the Rust
38+
Code of Conduct, see `CODE_OF_CONDUCT.md` for more.
39+
40+
Please send pull requests to the master branch. If you're trying to do
41+
something big, please open an issue before working on it, so we can make sure
42+
that it's something that will eventually be accepted.

0 commit comments

Comments
 (0)