Skip to content
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.

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

add readme to libraries and programs #1534

Merged
merged 8 commits into from
Jan 25, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
18 changes: 18 additions & 0 deletions libraries/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# 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 | Category | Status
-----------------------------------|--------------------------|-----------------------------------------------------------------------------|----------------|---------------
[app](app) | Application | Control the behaviour of the `witness_node` application, connect to the seeds, open he API, load plugins, etc. | Library | Active
oxarbitrage marked this conversation as resolved.
Show resolved Hide resolved
[chain](chain) | Blockchain | Define all objects, operations and types. This include the consensus protocol, defines the whole blockchain behaviour. | Library | Active
[db](db) | Database | Define the internal database graphene uses. | Library | Active
[egenesis](egenesis) | Genesis | | Library | Active
[fc](fc) | Fast-compiling C++ library | https://github.com/bitshares/bitshares-fc | Library | Active
[plugins](plugins) | Plugins | All plugin modules are stored here. | Library | Active
oxarbitrage marked this conversation as resolved.
Show resolved Hide resolved
[wallet](wallet) | Wallet | Wallet definition for the `cli_wallet` software. | Library | Active |
oxarbitrage marked this conversation as resolved.
Show resolved Hide resolved
20 changes: 20 additions & 0 deletions programs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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 blockchain software | Node | Active | `./witness_node --help`
[cli_wallet](cli_wallet) | CLI Wallet | Command line wallet | Wallet | Active | `./cli_wallet --help`
[delayed_node](delayed_node) | Delayed Node | Runs a node with `delayed_node` plugin loaded. This is deprecatd 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 | Provides wire size average in bytes of all the operations | Tool | Old | `./size_checker`
[build_helpers](build_helpers) | Build Helpers | | Tool | Old | `./member_enumerator` and `./cat-parts`
[genesis_util](genesis_util) | Gensis Utils | | Tool | Old |