-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added all hackage links * Added installation instructions, symlinked to docs * Polish docs * Fixed licence and author and github locations * Renamed project on main README * Clean up docs * Updated readme links in haddocks * Fix broken link * Changed font
- Loading branch information
Showing
33 changed files
with
164 additions
and
217 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
title: Installation | ||
--- | ||
|
||
## Build | ||
|
||
### Prerequisites | ||
|
||
#### stack | ||
At the moment the project's build is managed by `stack`. You can find everything you need regarding how to install stack on your machine [here](https://docs.haskellstack.org/en/stable/README/). | ||
|
||
#### protoc | ||
We use a custom setup to generate Haskell bindings to the protobuf files, using the proto-lens library from Google. In order for this to work you need to have the protobuf compiler `protoc` on your machine. You can get installation instructions [here](https://google.github.io/proto-lens/installing-protoc.html) | ||
|
||
#### libsecp256k1 | ||
In order to build with stack you will need this. On MacOS you can use brew: | ||
|
||
``` | ||
> brew tap cuber/homebrew-libsecp256k1 | ||
> brew install libsecp256k1 | ||
``` | ||
|
||
On linux: | ||
|
||
``` | ||
> sudo add-apt-repository ppa:tah83/secp256k1 | ||
> sudo apt-get update | ||
> sudo apt-get install libsecp256k1 | ||
``` | ||
|
||
#### style | ||
You will also need to install `hlint` and `stylish-haskell` for code hygiene during development. In the project root simply run | ||
|
||
```bash | ||
> stack install hlint stylish-haskell | ||
``` | ||
|
||
### Commands | ||
There is a `Makefile` for this project where you can find all of the options for building, testing etc. The `Makefile` | ||
is documented and there is a help menu which you can access via the commands `make` or `make help`. | ||
|
||
## Protobuf Files and Generated Modules | ||
The protobuf files are all in the `/protos` directory, and we use a custom setup in order | ||
to generate the corresponding `Proto.*` Haskell modules. If you want to view all of these | ||
generated modules, you can run | ||
|
||
```bash | ||
> find hs-abci-types/.stack-work -path '*autogen/Proto' | ||
``` | ||
|
||
to find the root directory. | ||
|
||
## Style Guide | ||
There is a `.stylish-haskell.yaml` file that controls some of the style guide, particularly | ||
around import statements and some indentation rules. There is also a small guide for things that | ||
fall outside of this in the [style wiki](https://github.com/f-o-a-m/kepler/wiki/code-style-guide). | ||
If it's not covered by either of these but you think it's really important, mention it in an issue. | ||
|
||
## Building documentation | ||
You can build the haddocks for the library code only using | ||
|
||
```bash | ||
make build-docs-local | ||
``` | ||
|
||
This does not build and link documentation for dependencies, useful mostly for testing | ||
documentation formatting. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,74 +1,14 @@ | ||
# hs-abci | ||
# kepler | ||
|
||
[![Build Status](https://travis-ci.com/f-o-a-m/hs-abci.svg?branch=master)](https://travis-ci.com/f-o-a-m/hs-abci) | ||
[![Build Status](https://travis-ci.com/f-o-a-m/kepler.svg?branch=master)](https://travis-ci.com/f-o-a-m/kepler) | ||
|
||
## Introduction | ||
This is the official repository for the Haskell implementation of the ABCI server and | ||
SDK for developing applications backed by the Tendermint replication engine. You can | ||
read more about Tendermint and the ABCI specs in their [documentation](https://tendermint.com/docs/spec/abci/). | ||
|
||
To understand how to build a simple application using this library, see the literate haskell [walkthrough](https://github.com/f-o-a-m/hs-abci/blob/master/hs-abci-examples/nameservice/README.md). | ||
To understand how to build a simple application using this library, see the literate haskell [walkthrough](https://github.com/f-o-a-m/kepler/blob/master/hs-abci-docs/nameservice/README.md). | ||
|
||
## Build | ||
|
||
### Prerequisites | ||
|
||
#### stack | ||
At the moment the project's build is managed by `stack`. You can find everything you need regarding how to install stack on your machine [here](https://docs.haskellstack.org/en/stable/README/). | ||
|
||
#### protoc | ||
We use a custom setup to generate Haskell bindings to the protobuf files, using the proto-lens library from Google. In order for this to work you need to have the protobuf compiler `protoc` on your machine. You can get installation instructions [here](https://google.github.io/proto-lens/installing-protoc.html) | ||
|
||
#### libsecp256k1 | ||
In order to build with stack you will need this. On MacOS you can use brew: | ||
|
||
``` | ||
> brew tap cuber/homebrew-libsecp256k1 | ||
> brew install libsecp256k1 | ||
``` | ||
|
||
On linux: | ||
|
||
``` | ||
> sudo add-apt-repository ppa:tah83/secp256k1 | ||
> sudo apt-get update | ||
> sudo apt-get install libsecp256k1 | ||
``` | ||
|
||
#### style | ||
You will also need to install `hlint` and `stylish-haskell` for code hygiene during development. In the project root simply run | ||
|
||
```bash | ||
> stack install hlint stylish-haskell | ||
``` | ||
|
||
### Commands | ||
There is a `Makefile` for this project where you can find all of the options for building, testing etc. The `Makefile` | ||
is documented and there is a help menu which you can access via the commands `make` or `make help`. | ||
|
||
## Protobuf Files and Generated Modules | ||
The protobuf files are all in the `/protos` directory, and we use a custom setup in order | ||
to generate the corresponding `Proto.*` Haskell modules. If you want to view all of these | ||
generated modules, you can run | ||
|
||
```bash | ||
> find hs-abci-types/.stack-work -path '*autogen/Proto' | ||
``` | ||
|
||
to find the root directory. | ||
|
||
## Style Guide | ||
There is a `.stylish-haskell.yaml` file that controls some of the style guide, particularly | ||
around import statements and some indentation rules. There is also a small guide for things that | ||
fall outside of this in the [style wiki](https://github.com/f-o-a-m/hs-abci/wiki/code-style-guide). | ||
If it's not covered by either of these but you think it's really important, mention it in an issue. | ||
|
||
## Building documentation | ||
You can build the haddocks for the library code only using | ||
|
||
```bash | ||
make build-docs-local | ||
``` | ||
|
||
This does not build and link documentation for dependencies, useful mostly for testing | ||
documentation formatting. | ||
See [installation instructions](https://github.com/f-o-a-m/kepler/blob/master/INSTALL.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
name: kepler | ||
synopsis: Haskell Cosmos SDK | ||
github: f-o-a-m/kepler | ||
author: Martin Allen | ||
author: f-o-a-m | ||
authorWebsite: https://foam.space | ||
color: #5E5184 | ||
#logo: https://pbs.twimg.com/profile_images/791467713956839424/pBRQn1wt_400x400.jpg | ||
titleFont: Poiret One | ||
titleFont: Lora | ||
titleFontWeight: 400 | ||
bodyFont: PT Sans | ||
bodyFont: Open Sans |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
title: Overview | ||
--- | ||
|
||
The documentation consists of an overview, foundations, a tutorial called ` nameservice` as well as documentation of logging and metrics. You can navigate to the relevant sections on the left side. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
../../INSTALL.md |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,12 @@ | ||
name: nameservice | ||
version: 0.1.0.0 | ||
github: "githubuser/nameservice" | ||
license: BSD3 | ||
author: "Author name here" | ||
maintainer: "[email protected]" | ||
copyright: "2019 Author name here" | ||
github: "f-o-a-m/kepler/hs-abci-docs/nameservice" | ||
license: Apache | ||
author: "Martin Allen" | ||
maintainer: "[email protected]" | ||
copyright: "2020 Martin Allen" | ||
|
||
|
||
# Metadata used when publishing your package | ||
# synopsis: Short description of your package | ||
# category: Web | ||
|
||
# To avoid duplicated efforts in documentation and dealing with the | ||
# complications of embedding Haddock markup inside cabal files, it is | ||
# common to point users to the README.md file. | ||
description: Please see the README on GitHub at <https://github.com/githubuser/nameservice#readme> | ||
description: Please see the README on GitHub at <https://github.com/f-o-a-m/kepler/blob/master/hs-abci-docs/nameservice/README.md> | ||
|
||
extra-source-files: | ||
- README.md | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.