Skip to content

Commit aa59940

Browse files
committed
Update the README
1 parent 2f6235f commit aa59940

File tree

1 file changed

+19
-28
lines changed

1 file changed

+19
-28
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Mcrouter [![Build Status](https://github.com/facebook/mcrouter/workflows/build/badge.svg)](https://github.com/facebook/mcrouter/actions?workflow=build)
1+
# Mcrouter [![Build Status](https://github.com/facebook/mcrouter/actions/workflows/getdeps_linux.yml/badge.svg)](https://github.com/facebook/mcrouter/actions/workflows/getdeps_linux.yml)
22
[![Support Ukraine](https://img.shields.io/badge/Support-Ukraine-FFD500?style=flat&labelColor=005BBB)](https://opensource.fb.com/support-ukraine) [![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/facebook/mcrouter/blob/master/LICENSE)
33

44
Mcrouter (pronounced mc router) is a memcached protocol router for scaling [memcached](https://memcached.org/)
@@ -12,42 +12,33 @@ See https://github.com/facebook/mcrouter/wiki to get started.
1212

1313
## Quick start guide
1414

15-
### New! Ubuntu package available
15+
### Building
1616

17-
Currently, we support Ubuntu Bionic (18.04) amd64.
18-
Here is how to install it:
17+
Mcrouter depends on [folly](https://github.com/facebook/folly), [wangle](https://github.com/facebook/wangle), [fizz](https://github.com/facebookincubator/fizz), [fbthrift](https://github.com/facebook/fbthrift)
18+
and [mvfst](https://github.com/facebook/mvfst).
1919

20-
Add the repo key:
20+
The `getdeps.py` tool, shared between many open source C++ projects at Meta, may be used to build mcrouter and its dependencies:
2121

22-
$ wget -O - https://facebook.github.io/mcrouter/debrepo/bionic/PUBLIC.KEY | sudo apt-key add
22+
# Clone the repo
23+
git clone https://github.com/facebook/mcrouter.git
24+
cd mcrouter
2325

24-
Add the following line to apt sources file /etc/apt/sources.list
26+
# Build, using system dependencies if available, including tests
27+
./build/fbcode_builder/getdeps.py --allow-system-packages build mcrouter
2528

26-
deb https://facebook.github.io/mcrouter/debrepo/bionic bionic contrib
29+
# Build, using system dependencies if available, without tests
30+
./build/fbcode_builder/getdeps.py --allow-system-packages --no-tests build mcrouter
2731

28-
Update the local repo cache:
32+
Once built, you may use `getdeps.py` to run the tests as well:
2933

30-
$ sudo apt-get update
34+
# Run the tests
35+
./build/fbcode_builder/getdeps.py --allow-system-packages test
3136

32-
Install mcrouter:
37+
### Packaging
38+
mcrouter ships with a basic `CPack` configuration that may be used to package it for your Linux distribution.
39+
After building the project, change to its `getdeps.py` scratch dir, and run `cpack` with the appropriate generator.
3340

34-
$ sudo apt-get install mcrouter
35-
36-
37-
### Installing From Source
38-
39-
See https://github.com/facebook/mcrouter/wiki/mcrouter-installation for more
40-
detailed installation instructions.
41-
42-
Mcrouter depends on [folly](https://github.com/facebook/folly), [wangle](https://github.com/facebook/wangle), [fizz](https://github.com/facebookincubator/fizz), and [fbthrift](https://github.com/facebook/fbthrift).
43-
44-
The installation is a standard autotools flow:
45-
46-
$ autoreconf --install
47-
$ ./configure
48-
$ make
49-
$ sudo make install
50-
$ mcrouter --help
41+
### Running mcrouter
5142

5243
Assuming you have a memcached instance on the local host running on port 5001,
5344
the simplest mcrouter setup is:

0 commit comments

Comments
 (0)