Skip to content

Commit

Permalink
Info (README, ChangeLog, help) updated.
Browse files Browse the repository at this point in the history
  • Loading branch information
graninas committed Dec 11, 2018
1 parent 15b4976 commit b667234
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 10 deletions.
6 changes: 6 additions & 0 deletions ChangeLog.md
@@ -1,5 +1,11 @@
# Node project changelog

## Changes in v0.7.0
- Repository now contains framework, sample nodes and tests.
It is cleared from company-specific business logic.
It is now suitable to build your own applications.
- Executable is now `enq-test-node-haskell`.

## Changes in v0.6.0
- Framework updates:
* Framework structure improvements (renamings, movings)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -21,15 +21,14 @@ Enecuum Node Framework allows to build network actors and blockchain protocols,
The Node project contains:

- Enecuum Node Framework
- Blockchain algorithms and data structures
- Sample nodes with configs
- Testing environment
- Tests (functional, integration)

## Framework structure

- Source code located in [./src/](./src/)
- Configs for test nodes located in [./configs/](./configs/)
- Configs for sample nodes located in [./configs/](./configs/)
- Test code located in [./test/](./test/)

The framework represents a set of embedded monadic languages organized hierarchically. The languages are divided to core languages responsible for common subsystems and framework languages responsible for network and actors behavior.
Expand Down Expand Up @@ -280,6 +279,7 @@ pongClientNode cfg = do

# Additional materials

* [Building network actors with Enecuum Node Framework (tutorial)](https://gist.github.com/graninas/9beb8df5d88dda5fa21c47ce9bcb0e16)
* [Why Haskell?](https://medium.com/@ENQBlockchain/why-haskell-eacb087f3adb)
* [Enecuum. Framework possibilities](https://medium.com/@ENQBlockchain/enecuum-framework-possibilities-d4fa49c3ea40)
* [Enecuum.Framework Possibilities, Part 2](https://medium.com/@ENQBlockchain/enecuum-framework-possibilities-part-2-7c8ff65c1c4e)
8 changes: 4 additions & 4 deletions app/Enecuum/Main.hs
@@ -1,15 +1,15 @@
module Main where

import Enecuum.Config (withConfig)
import Enecuum.Prelude
import Enecuum.Samples.Assets.GenConfigs (genConfigs)
import Enecuum.Samples.Assets.Initialization (initialize)
import Enecuum.Config (withConfig)
import Enecuum.Prelude

help :: IO ()
help = putStrLn @Text $ "Please, specify node config:"
<> "\n\n$ enq-node-haskell singlenode configs/tst_graph_node_transmitter.json"
<> "\n\n$ enq-test-node-haskell singlenode configs/tst_graph_node_transmitter.json"
<> "\n\nOr generate default configs (they will be placed to ./configs/default):"
<> "\n\n$ enq-node-haskell generate-configs"
<> "\n\n$ enq-test-node-haskell generate-configs"

main :: IO ()
main = do
Expand Down
7 changes: 3 additions & 4 deletions package.yaml
Expand Up @@ -12,7 +12,7 @@ extra-source-files:

description:
Node is the project that allows to build network actors and blockchain protocols.
It contains Enecuum.Framework, test nodes and main nodes of the Enecuum blockchain.
It contains Enecuum.Framework and sample nodes performing some blockchain-like activity.
Please see the README.md at <https://github.com/Enecuum/Node/blob/master/README.md>.

default-extensions:
Expand Down Expand Up @@ -123,13 +123,12 @@ executables:
tests:
functional-tests:
main: Spec.hs

dependencies:
- Node
- Node
source-dirs:
- test/spec
ghc-options:
- -threaded
- -rtsopts
- -with-rtsopts=-N

0 comments on commit b667234

Please sign in to comment.