Commit 0887b7ac authored by Nicholas Ormrod's avatar Nicholas Ormrod Committed by Alecs King

README: Fixed typo, formatted code, and linked to docs

Summary:
(from @njormrod) This changes the READMEs to be .md,
appropriate for github. I viewed the docs on github, and they looked
WAY better as .md files.
Signed-off-by: default avatarNicholas Ormrod <njormrod@fb.com>

Test Plan: view on github

Reviewed By: markisaa@fb.com

Subscribers: fugalh, folly-diffs@, jsedgwick, yfeldblum, chalfant

FB internal diff: D1999531

Tasks: 6783581

Signature: t1:1999531:1429220432:68c6d8dc70806d993c83cacce6369cb7e6e964c8
parent 4f7459c3
...@@ -3,13 +3,12 @@ Folly: Facebook Open-source LibrarY ...@@ -3,13 +3,12 @@ Folly: Facebook Open-source LibrarY
Folly is an open-source C++ library developed and used at Facebook. Folly is an open-source C++ library developed and used at Facebook.
For details, see folly/docs/Overview.md. ###[Get Started](folly/docs/Overview.md)
Folly is published on Github at https://github.com/facebook/folly; for Folly is published on Github at https://github.com/facebook/folly; for
discussions, there is a Google group at discussions, there is a Google group at
https://groups.google.com/d/forum/facebook-folly. https://groups.google.com/d/forum/facebook-folly.
Dependencies Dependencies
------------ ------------
...@@ -25,6 +24,7 @@ Ubuntu 13.10 ...@@ -25,6 +24,7 @@ Ubuntu 13.10
The following packages are required (feel free to cut and paste the apt-get The following packages are required (feel free to cut and paste the apt-get
command below): command below):
```
sudo apt-get install \ sudo apt-get install \
g++ \ g++ \
automake \ automake \
...@@ -44,23 +44,28 @@ sudo apt-get install \ ...@@ -44,23 +44,28 @@ sudo apt-get install \
binutils-dev \ binutils-dev \
libjemalloc-dev \ libjemalloc-dev \
libssl-dev libssl-dev
```
Ubuntu 14.04 LTS Ubuntu 14.04 LTS
---------------- ----------------
The packages listed above for Ubuntu 13.10 are required, as well as: The packages listed above for Ubuntu 13.10 are required, as well as:
```
sudo apt-get install \ sudo apt-get install \
libiberty-dev libiberty-dev
```
The above packages are sufficient for Ubuntu 13.10 and Ubuntu 14.04. The above packages are sufficient for Ubuntu 13.10 and Ubuntu 14.04.
In the folly directory, run In the folly directory, run
```
autoreconf -ivf autoreconf -ivf
./configure ./configure
make make
make check make check
sudo make install sudo make install
```
OS X OS X
---- ----
...@@ -69,10 +74,12 @@ of writing (OS X Yosemite 10.10.1) the default compiler (clang) has some ...@@ -69,10 +74,12 @@ of writing (OS X Yosemite 10.10.1) the default compiler (clang) has some
issues building, but gcc 4.9.2 from Homebrew works fine. (This is taken care issues building, but gcc 4.9.2 from Homebrew works fine. (This is taken care
of by the bootstrap script.) of by the bootstrap script.)
```
cd folly cd folly
./bootstrap-osx-homebrew.sh ./bootstrap-osx-homebrew.sh
make make
make check make check
```
Other Linux distributions Other Linux distributions
------------------------- -------------------------
...@@ -82,11 +89,11 @@ Other Linux distributions ...@@ -82,11 +89,11 @@ Other Linux distributions
Download and build double-conversion. Download and build double-conversion.
You may need to tell configure where to find it. You may need to tell configure where to find it.
[double-conversion/] ln -s src double-conversion [double-conversion/] `ln -s src double-conversion`
[folly/] ./configure LDFLAGS=-L$DOUBLE_CONVERISON_HOME/ CPPFLAGS=-I$DOUBLE_CONVERISON_HOME/ [folly/] `./configure LDFLAGS=-L$DOUBLE_CONVERISON_HOME/ CPPFLAGS=-I$DOUBLE_CONVERISON_HOME/`
[folly/] LD_LIBRARY_PATH=$DOUBLE_CONVERISON_HOME/ make [folly/] `LD_LIBRARY_PATH=$DOUBLE_CONVERISON_HOME/ make`
- additional platform specific dependencies: - additional platform specific dependencies:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment