Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix build guidance for 0.2 #206

Merged
merged 3 commits into from
Nov 6, 2022
Merged

Fix build guidance for 0.2 #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39df509
Update installation.md
wu-sheng Nov 6, 2022
7337c09
Amend more details
hanahmily Nov 6, 2022
576f524
Remove root path
hanahmily Nov 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,16 @@ Users who want to build a binary from sources have to set up:
* Go 1.19
* Node 16.15
* Git >= 2.30
* Linux, MacOS or Windows+WSL2
* Linux, macOS or Windows+WSL2
* GNU make

### Windows

BanyanDB is built on Linux and MacOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you to use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.
BanyanDB is built on Linux and macOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.

#### End of line sequence

BanyanDB ALWAYS use `LF`(`\n`) as the line endings, even on a Windows. So we need your development tool and IDEs to generate new files with `LF` as its end of lines.
BanyanDB ALWAYS uses `LF`(`\n`) as the line endings, even on Windows. So we need your development tool and IDEs to generate new files with `LF` as its end of lines.

## Building and Testing

Expand All @@ -75,7 +75,7 @@ Finally, run `make build` in the source directory, which will build the default
make build
```

Please refer to [installation](./docs/installation.md) for more details.
Please refer to the [installation](./docs/installation.md) for more details.

Test your changes before submitting them by

Expand All @@ -91,7 +91,7 @@ We have some rules for the code style and please lint your codes locally before
make lint
```

If you found some errors in the output of the above command, try `make format` to fix some obvious style issues. As for the complicated errors, please correct them manually.
If you found some errors in the output of the above command, try to `make format` to fix some obvious style issues. As for the complicated errors, please correct them manually.

## Update licenses

Expand Down
38 changes: 31 additions & 7 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,50 @@

`Banyand` is the daemon server of the BanyanDB database. This section will show several paths installing it in your environment.

## Get Banyand
## Get Binaries

### Released binaries

Get binaries from [download](https://skywalking.apache.org/downloads/).
Get binaries from the [download](https://skywalking.apache.org/downloads/).

### Build From Source

#### Requirements

Users who want to build a binary from sources have to set up:

* Go >= 1.19
* Linux or MacOS
* Go 1.19
* Node 16.15
* Git >= 2.30
* Linux, macOS or Windows+WSL2
* GNU make

#### Build Banyand
#### Windows

To issue the below command to get a basic binary.
BanyanDB is built on Linux and macOS that introduced several platform-specific characters to the building system. Therefore, we highly recommend you use [WSL2+Ubuntu](https://ubuntu.com/wsl) to execute tasks of the Makefile.

#### Build Binaries

To issue the below command to get basic binaries of banyand and bydbctl.

```shell
$ make generate
...
$ make build
...
--- banyand: all ---
make[1]: Entering directory '<path_to_project_root>/banyand'
...
chmod +x build/bin/banyand-server
Done building banyand server
make[1]: Leaving directory '<path_to_project_root>/banyand'
...
--- bydbctl: all ---
make[1]: Entering directory '<path_to_project_root>/bydbctl'
...
chmod +x build/bin/bydbctl
Done building bydbctl
make[1]: Leaving directory '<path_to_project_root>/bydbctl'
```

The build system provides a series of binary options as well.
Expand All @@ -35,6 +55,7 @@ The build system provides a series of binary options as well.
* `make -C banyand release` builds out a static binary for releasing.
* `make -C banyand debug` gives a binary for debugging without the complier's optimizations.
* `make -C banyand debug-static` is a static binary for debugging.
* `make -C bydbctl release` cross-builds several binaries for multi-platforms.

Then users get binaries as below

Expand All @@ -44,6 +65,9 @@ banyand-server
banyand-server-debug
banyand-server-debug-static
banyand-server-static

$ ls banyand/build/bin
bydbctl
```

## Setup Banyand
Expand Down Expand Up @@ -95,7 +119,7 @@ $ ./banyand-server standalone

The banyand-server would be listening on the `0.0.0.0:17912` if no errors occurred.

To discovery more options to configure the banyand by
To discover more options to configure the banyand by

```shell
$ ./banyand-server standalone -h
Expand Down