Skip to content

Expand installation guide links #354

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

Open
jiapengwang-code wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Expand installation guide links #354

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,28 @@
# Installation

See [doc/build-\*.md](/doc)
Bitgesell Core can be built from source on Linux, macOS, Windows, and BSD systems. The platform-specific build guides in [`doc/`](doc) contain the required dependencies and detailed instructions.

## Platform build guides

- [Unix/Linux](doc/build-unix.md)
- [macOS](doc/build-osx.md)
- [Windows](doc/build-windows.md)
- [FreeBSD](doc/build-freebsd.md)
- [OpenBSD](doc/build-openbsd.md)
- [NetBSD](doc/build-netbsd.md)

## Quick source build

On supported Unix-like systems, the usual autotools flow is:

```sh
./autogen.sh
./configure
make
make check
sudo make install
```

Run `./configure --help` to review optional build flags before compiling.

For deterministic release builds and platform-specific dependency notes, use the relevant guide linked above.