bahman/scylla
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

README.md: Add quick-start section and defer to HACKING.md

Browse Source
This commit is contained in:
Jesse Haber-Kucharsky
2017-07-21 17:16:36 -04:00
parent d06bccf857
commit d6c0138576
1 changed files with 10 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -1,31 +1,19 @@
# Scylla
## Building Scylla
## Quick-start
In addition to required packages by Seastar, the following packages are required by Scylla.
### Submodules
Scylla uses submodules, so make sure you pull the submodules first by doing:
```
git submodule init
git submodule update --init --recursive
```bash
$ git submodule update --init --recursive
$ sudo ./install-dependencies.sh
$ ./configure.py --mode=release
$ ninja-build -j4 # Assuming 4 system threads.
$ ./build/release/scylla
$ # Rejoice!
```
### Building Scylla
Please see [HACKING.md](HACKING.md) for detailed information on building and developing Scylla.
* Installing required packages
```
sudo ./install-dependencies.sh
```
* Build Scylla
```
./configure.py --mode=release --with=scylla --disable-xen
ninja-build build/release/scylla -j2 # you can use more cpus if you have tons of RAM
```
### Running Scylla
## Running Scylla
* Run Scylla
```
@@ -87,6 +75,4 @@ docker run -p $(hostname -i):9042:9042 -i -t <image name>
## Contributing to Scylla
[Guide to getting started with development](HACKING.md)
[Guidelines for contributing](CONTRIBUTING.md)