From 909c1022c6544b5dc78490d73d7dcfab5c259aeb Mon Sep 17 00:00:00 2001 From: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Date: Wed, 24 Oct 2018 16:14:11 +1000 Subject: [PATCH] Getting started (#135) * Updated to use command line and move to less confusing location --- GETTING-STARTED.md | 6 ------ docs/GettingStartedBinaries.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 6 deletions(-) delete mode 100644 GETTING-STARTED.md create mode 100644 docs/GettingStartedBinaries.md diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md deleted file mode 100644 index ed08b3fdb7..0000000000 --- a/GETTING-STARTED.md +++ /dev/null @@ -1,6 +0,0 @@ -# Getting Started -**Pantheon 0.8.0 RC2 release** -After you clone the PegaSysEng/pantheon repo, we recommend that you first run the 'pantheon' startup script for Linux/MacOS (or the 'pantheon.bat' startup script for Windows) in the pantheon-/bin directory. This script appropriately sets system variables and command-line arguments for Java, JVM, and Pantheon. -After you've run the startup script, we encourage you to read the Pantheon technical documentation, located on the wiki tab of PegaSysEng/pantheon: - https://github.com/PegaSysEng/pantheon/wiki -This wiki provides detailed information on getting started, along with tutorials and comprehensive reference content. diff --git a/docs/GettingStartedBinaries.md b/docs/GettingStartedBinaries.md new file mode 100644 index 0000000000..ec131dec64 --- /dev/null +++ b/docs/GettingStartedBinaries.md @@ -0,0 +1,15 @@ +# Getting Started with Pantheon + +After you download and unpackage Pantheon: +1. At the command line, change into the `pantheon-` directory. + +2. To display the command line help: + ```json + ./bin/pantheon --help + ``` + +A [basic quickstart](https://github.com/PegaSysEng/pantheon/wiki/Quickstart) and other options for [starting Pantheon](https://github.com/PegaSysEng/pantheon/wiki/Starting-Pantheon) are included in the documentation. + +The documentation is included in this release package and on the [Pantheon Wiki](https://github.com/PegaSysEng/pantheon/wiki). + +>**Note** Starting Pantheon by double-clicking the `pantheon` or `pantheon.bat` executables starts a node synchronizing with the Ethereum mainnet. \ No newline at end of file