Merge README and Makefile from recode-c.

hsivonen · hsivonen · commit 6fa383092449 · 2016-02-22T15:12:16.000+02:00
diff --git a/Makefile b/Makefile
@@ -13,6 +13,8 @@ LDFLAGS = -Wl,--gc-sections -ldl -lpthread -lgcc_s -lrt -lc -lm -lstdc++
 recode_cpp: recode_cpp.o ../encoding-rs/target/release/libencoding_rs.a
 	$(CC) -o $@ $^ $(LDFLAGS)
 
+recode_c.o: recode_c.c ../encoding-rs/target/include/encoding_rs.h
+
 ../encoding-rs/target/release/libencoding_rs.a: cargo
 
 ../encoding-rs/target/include/encoding_rs.h: cargo
diff --git a/README.md b/README.md
@@ -9,3 +9,44 @@ It expects encoding-rs and [GSL](https://github.com/Microsoft/GSL) to have been
 
 Please see the file named COPYRIGHT.
 
+## Building
+
+Git, GNU Make and a version of GCC recent enough to accept `-std=c11` are
+assumed to be already installed.
+
+###0. Install Rust (including Cargo) if you haven't already
+
+See the [Rust download page](https://www.rust-lang.org/downloads.html). For
+Linux and OS X, this means:
+```
+curl -sSf https://static.rust-lang.org/rustup.sh | sh
+```
+
+###1. Clone encoding-rs
+
+```
+git clone https://github.com/hsivonen/encoding-rs.git
+```
+
+###2. Enable staticlib support for encoding-rs
+
+Edit `encoding-rs/Cargo.toml` and uncomment the line
+```
+# crate-type = ["rlib", "staticlib"]
+```
+
+(The line is commented out due to a
+[rustfmt bug](https://github.com/rust-lang-nursery/rustfmt/issues/828).)
+
+###3. Clone recode-c
+
+```
+git clone https://github.com/hsivonen/recode-c.git
+```
+
+###4. Build recode-c
+
+```
+cd recode-c
+make
+```
