<commit_before>counterpartyd Build System (counterpartyd_build)
==================================================

`counterpartyd_build <https://github.com/xnova/counterpartyd_build>`__ is the automated build system for
`counterpartyd <https://github.com/PhantomPhreak/counterpartyd>`__. This is an alternative method from
`manual counterpartyd installation and running <https://github.com/PhantomPhreak/counterpartyd/blob/master/README.md>`__,
which includes a point-and-click Windows installer, as well as a source code build script that takes care of
all setup necessary to run ``counterpartyd`` from source.

**Using the build system, you have the following options:**

- If you are a **Windows user**, you can either :doc:`use the installer package <UsingTheInstaller>`, or
  :doc:`build from source <BuildingFromSource>`
- If you are an **Ubuntu Linux user**, you can :doc:`use the build system to automate your
  install/setup from source <BuildingFromSource>`
- If you are **neither**, at this point you will need to follow `the manual installation instructions <https://github.com/PhantomPhreak/counterpartyd/blob/master/README.md>`__.


When to use?
------------------

This build system will probably be especially helpful in any of the following circumstances:

- You are a Windows user, or a Linux user that isn't super experienced with the command line interface.
- You want to deploy ``counterpartyd`` in a production environment, and have it run automatically on system startup
- You want to build your own ``counterpartyd`` binaries

Future plans
------------------

Future plans for the build system (*pull requests for these features would be greatly appreciated*):

- Add support for Linux distributions beyond Ubuntu Linux
- Add support for Mac OS X automated setup from source
- Add support for creation of installer for Mac OS X
- Add support for creation of ``.rpm``, ``.deb.``, etc. binary packages for Linux

More information on Counterparty is available in the `specs <https://github.com/PhantomPhreak/Counterparty>`__.


Table of Contents
------------------

.. toctree::
   :maxdepth: 3

   SettingUpBitcoind
   UsingTheInstaller
   BuildingFromSource
   API
   AdditionalTopics
   HowToBurn


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

<commit_msg>leave API out until finalized<commit_after>counterpartyd Build System (counterpartyd_build)
==================================================

`counterpartyd_build <https://github.com/xnova/counterpartyd_build>`__ is the automated build system for
`counterpartyd <https://github.com/PhantomPhreak/counterpartyd>`__. This is an alternative method from
`manual counterpartyd installation and running <https://github.com/PhantomPhreak/counterpartyd/blob/master/README.md>`__,
which includes a point-and-click Windows installer, as well as a source code build script that takes care of
all setup necessary to run ``counterpartyd`` from source.

**Using the build system, you have the following options:**

- If you are a **Windows user**, you can either :doc:`use the installer package <UsingTheInstaller>`, or
  :doc:`build from source <BuildingFromSource>`
- If you are an **Ubuntu Linux user**, you can :doc:`use the build system to automate your
  install/setup from source <BuildingFromSource>`
- If you are **neither**, at this point you will need to follow `the manual installation instructions <https://github.com/PhantomPhreak/counterpartyd/blob/master/README.md>`__.


When to use?
------------------

This build system will probably be especially helpful in any of the following circumstances:

- You are a Windows user, or a Linux user that isn't super experienced with the command line interface.
- You want to deploy ``counterpartyd`` in a production environment, and have it run automatically on system startup
- You want to build your own ``counterpartyd`` binaries

Future plans
------------------

Future plans for the build system (*pull requests for these features would be greatly appreciated*):

- Add support for Linux distributions beyond Ubuntu Linux
- Add support for Mac OS X automated setup from source
- Add support for creation of installer for Mac OS X
- Add support for creation of ``.rpm``, ``.deb.``, etc. binary packages for Linux

More information on Counterparty is available in the `specs <https://github.com/PhantomPhreak/Counterparty>`__.


Table of Contents
------------------

.. toctree::
   :maxdepth: 3

   SettingUpBitcoind
   UsingTheInstaller
   BuildingFromSource
   AdditionalTopics
   HowToBurn


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


{'fraction_non_alphanumeric': 0.1294748124330118, 'fraction_numerical': 0.00042872454448017146, 'mean_word_length': 4.133113311331133, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4959930', 'n_tokens_mistral': 1243, 'n_tokens_neox': 1175, 'n_words': 527}