github.com/klaytn/klaytn@v1.12.1/cmd/homi/setup/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2016 The go-ethereum Authors
     3  // This file is part of go-ethereum.
     4  //
     5  // Copyright 2017 AMIS Technologies
     6  // This file is part of the go-ethereum library.
     7  //
     8  // The go-ethereum library is free software: you can redistribute it and/or modify
     9  // it under the terms of the GNU Lesser General Public License as published by
    10  // the Free Software Foundation, either version 3 of the License, or
    11  // (at your option) any later version.
    12  //
    13  // The go-ethereum library is distributed in the hope that it will be useful,
    14  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    15  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    16  // GNU Lesser General Public License for more details.
    17  //
    18  // You should have received a copy of the GNU Lesser General Public License
    19  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    20  //
    21  
    22  /*
    23  setup package generates config files following the given deployment options.
    24  It creates the given number of genesis.json and nodekeys
    25  
    26  Source Files
    27  
    28  Each file contains the following contents
    29   - cmd.go : Provides functions to generate config files with given deployment configuration
    30   - flags.go : Defines command line flags which can be used in `setup` command
    31   - klaytn_config.go : Defines `KlaytnConfig` and provides a template to build it
    32   - prometheus_config.go : Defines `PrometheusConfig` and provides a template to build it
    33  */
    34  package setup