mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-06-09 07:36:43 +00:00
1cd2eb9308
* [NOD-494] Updated main README.md * [NOD-494] Updated blockdag/README.md * [NOD-494] Aligned text length in main README.md * [NOD-494] Updated most remaining packages READMEs + deleted util/coinset * [NOD-494] Update integration README * [NOD-494] Did a final pass over all readmes * [NOD-494] Updated README for DNSSeeder with more info on how to create a functioning setup * [NOD-494] Remove all double spaces from readmes * [NOD-494] Minor fixes in READMEs + update license to kaspanet developers * [NOD-494] Add backtick around ecc and util in hdkeychain README
80 lines
2.3 KiB
Markdown
80 lines
2.3 KiB
Markdown
|
|
Kaspad
|
|
====
|
|
Warning: This is pre-alpha software. There's no guarantee anything works.
|
|
====
|
|
|
|
[](http://copyfree.org)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad)
|
|
|
|
Kaspad is the reference full node Kaspa implementation written in Go (golang).
|
|
|
|
This project is currently under active development and is in a pre-Alpha state.
|
|
Some things still don't work and APIs are far from finalized. The code is provided for reference only.
|
|
|
|
## Requirements
|
|
|
|
Latest version of [Go](http://golang.org) (currently 1.13).
|
|
|
|
## Installation
|
|
|
|
#### Build from Source
|
|
|
|
- Install Go according to the installation instructions here:
|
|
http://golang.org/doc/install
|
|
|
|
- Ensure Go was installed properly and is a supported version:
|
|
|
|
```bash
|
|
$ go version
|
|
$ go env GOROOT GOPATH
|
|
```
|
|
|
|
NOTE: The `GOROOT` and `GOPATH` above must not be the same path. It is
|
|
recommended that `GOPATH` is set to a directory in your home directory such as
|
|
`~/dev/go` to avoid write permission issues. It is also recommended to add
|
|
`$GOPATH/bin` to your `PATH` at this point.
|
|
|
|
- Run the following commands to obtain and install kaspad including all dependencies:
|
|
|
|
```bash
|
|
$ git clone https://github.com/kaspanet/kaspad $GOPATH/src/github.com/kaspanet/kaspad
|
|
$ cd $GOPATH/src/github.com/kaspanet/kaspad
|
|
$ ./test.sh
|
|
$ go install . ./cmd/...
|
|
```
|
|
`./test.sh` tests can be skipped, but some things might not run correctly on your system if tests fail.
|
|
|
|
- Kaspad (and utilities) should now be installed in `$GOPATH/bin`. If you did
|
|
not already add the bin directory to your system path during Go installation,
|
|
you are encouraged to do so now.
|
|
|
|
|
|
## Getting Started
|
|
|
|
Kaspad has several configuration options available to tweak how it runs, but all
|
|
of the basic operations work with zero configuration.
|
|
|
|
#### Linux/BSD/POSIX/Source
|
|
|
|
```bash
|
|
$ ./kaspad
|
|
```
|
|
|
|
## Discord
|
|
Join our discord server using the following link: https://discord.gg/WmGhhzk
|
|
|
|
## Issue Tracker
|
|
|
|
The [integrated github issue tracker](https://github.com/kaspanet/kaspad/issues)
|
|
is used for this project.
|
|
|
|
## Documentation
|
|
|
|
The documentation is a work-in-progress. It is located in the [docs](https://github.com/kaspanet/kaspad/tree/master/docs) folder.
|
|
|
|
## License
|
|
|
|
Kaspad is licensed under the [copyfree](http://copyfree.org) ISC License.
|
|
|