diff --git a/libraries/README.md b/libraries/README.md new file mode 100644 index 0000000000..256d15029b --- /dev/null +++ b/libraries/README.md @@ -0,0 +1,20 @@ +# BitShares Libraries + +The libraries are the core of the project and defines everything where applications can build on top. + +A **graphene** blockchain software will use the `app` library to define what the application will do, what services it will offer. The blockchain is defined by the `chain` library and include all the objects, types, operations, protocols that builds current consensus blockchain. The lowest level in memory database of Bitshares is developed at the `db` library. The `fc` is a helper module broadly used in the libraries code, `egenesis` will help with the genesis file, `plugins` will be loaded optionally to the application. Wallet software like the cli_wallet will benefit from the `wallet` library. + +Code in libraries is the most important part of **bitshares-core** project and it is maintained by the Bitshares Core Team and contributors. +# Available Libraries + +Folder | Name | Description | Status +---|---|---|--- +[app](app) | Application | Bundles component libraries (chain, network, plugins) into a useful application. Also provides API access. | Active +[chain](chain) | Blockchain | Defines all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Active +[db](db) | Database | Defines the internal database graphene uses. | Active +[egenesis](egenesis) | Genesis | Hardcodes the `genesis.json` file into the `witness_node` executable.| Active +[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Active +[net](net) | Network | The graphene p2p layer. | Active +[plugins](plugins) | Plugins | Collection of singleton designed modules used for extending the bitshares-core. | Active +[utilities](utilities) | Utilities | Common utility calls used in applications or other libraries. | Active +[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Active diff --git a/programs/README.md b/programs/README.md new file mode 100644 index 0000000000..26b2b36886 --- /dev/null +++ b/programs/README.md @@ -0,0 +1,23 @@ +# BitShares Programs + +The bitshares programs are a collection of binaries to run the blockchain, interact with it or utilities. + +The main program is the `witness_node`, used to run a bitshares block producer, API or plugin node. The second in importance is the `cli_wallet`, used to interact with the blockchain. This 2 programs are the most used by the community and updated by the developers, rest of the programs are utilities. + +Programs in here are part of the **bitshares-core** project and are maintained by the bitshares core team and contributors. + + +# Available Programs + +Folder | Name | Description | Category | Status | Help +---|---|---|---|---|--- +[witness_node](witness_node) | Witness Node | Main software used to sign blocks or provide services. | Node | Active | `./witness_node --help` +[cli_wallet](cli_wallet) | CLI Wallet | Software to interact with the blockchain by command line. | Wallet | Active | `./cli_wallet --help` +[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecated in favour of `./witness_node --plugins "delayed_node"`. | Node | Deprecated | `./delayed_node --help` +[js_operation_serializer](js_operation_serializer) | Operation Serializer | Dump all blockchain operations and types. Used by the UI. | Tool | Old | `./js_operation_serializer` +[size_checker](size_checker) | Size Checker | Return wire size average in bytes of all the operations. | Tool | Old | `./size_checker` +[cat-parts](build_helpers/cat-parts.cpp) | Cat parts | Used to create `hardfork.hpp` from individual files. | Tool | Active | `./cat-parts` +[check_reflect](build_helpers/check_reflect.py) | Check reflect | Check reflected fields automatically(https://github.com/cryptonomex/graphene/issues/562) | Tool | Old | `doxygen;cp -rf doxygen programs/build_helpers; ./check_reflect.py` +[member_enumerator](build_helpers/member_enumerator.cpp) | Member enumerator | | Tool | Deprecated | `./member_enumerator` +[get_dev_key](genesis_util/get_dev_key.cpp) | Get Dev Key | Create public, private and address keys. Useful in private testnets, `genesis.json` files, new blockchain creation and others. | Tool | Active | `/programs/genesis_util/get_dev_key -h` +[genesis_util](genesis_util) | Genesis Utils | Other utilities for genesis creation. | Tool | Old |