Added details to the README.md #14
Conversation
Added details on how to access the created wallet when using "./create_wallet.sh" or "./docker_run_and_create_wallet.sh". Added details on how to get your docker-machine IP (It doesn't work with localhost or if you use the docker container IP). Added a note about copying the wallets from docker image to gui (It's not necessary if you use the commands above).
README.md
Outdated
| neo-privnet.wallet : a wallet you can use with neo-python | ||
| neo-privnet.wif : a wif private key you can import into other clients (neo-gui for exemple). | ||
|
|
||
| Those files will get you access to the wallet containing all the NEOs of your private network. |
There was a problem hiding this comment.
markdown formatting is messed up here, it's treating this line as a sub-heading
|
Here is a website where you can paste markdown and see the resulting HTML: https://jbt.github.io/markdown-editor There is errors in this PR, the subheader like @AshRolls mentioned, and the points above should perhaps be bullet points. |
README.md
Outdated
|
|
||
| docker-machine ip "Nameofyourmachine" | ||
|
|
||
| (By default, the machine name is "default"). |
There was a problem hiding this comment.
These steps are only useful in windows for Windows Home users who don't have hyper-v (so use docker-machine). It should be put into a sub-section to make that distinction clear
Took PR remarks in consideration
README.md
Outdated
| @@ -36,6 +38,15 @@ You can now claim the initial NEO and GAS: | |||
|
|
|||
| `./create_wallet` will display several internal error messages, which is expected as long as at the end you still get a success message. | |||
|
|
|||
| If you call ./create_wallet.sh or ./docker_run_and_create_wallet.sh, it will create 2 files in your current directory : | |||
There was a problem hiding this comment.
./create_wallet.sh and ./docker_run_and_create_wallet.sh should both be shown with code markup ``
README.md
Outdated
| @@ -10,6 +10,8 @@ See the section below on extracting Neo and Gas as the private chain in this doc | |||
| You will also need to install and configure the neo-gui pc client on your favorite distro. This involves editing the protocol.json file to point the seeds at your docker IP addresses. | |||
|
|
|||
|
|
|||
|
|
|||
There was a problem hiding this comment.
don't add so many empty lines
README.md
Outdated
| @@ -36,6 +38,15 @@ You can now claim the initial NEO and GAS: | |||
|
|
|||
| `./create_wallet` will display several internal error messages, which is expected as long as at the end you still get a success message. | |||
|
|
|||
| If you call ./create_wallet.sh or ./docker_run_and_create_wallet.sh, it will create 2 files in your current directory : | |||
|
|
|||
| - neo-privnet.wallet : a wallet you can use with neo-python | |||
There was a problem hiding this comment.
wrap filenames in code markup ``
README.md
Outdated
|
|
||
| Those files will get you access to the wallet containing all the NEOs of your private network. | ||
|
|
||
|
|
There was a problem hiding this comment.
only have 1 blank line here
README.md
Outdated
| @@ -62,15 +73,30 @@ If you copy the protocol.json file from the configs directory of this repo and r | |||
| ], | |||
|
|
|||
| Change each occurrence of 127.0.0.1 to the IP of the system or vm running your docker image. | |||
|
|
|||
There was a problem hiding this comment.
1 blank line should be here
README.md
Outdated
| ## Copy wallets from docker image to neo-gui | ||
|
|
||
| Note : You won't need this step if you used ./create_wallet.sh or ./docker_run_and_create_wallet.sh in the previous step (The multiparty signature and neo/gas extraction should already be done). |
There was a problem hiding this comment.
wrap commands in code markup ``
Wrapped commands in code markup Removed useless lines Sorry about the messed up PR, didn't know about markup conventions. Will take extra care next time :)
README.md
Outdated
| If you call ./create_wallet.sh or ./docker_run_and_create_wallet.sh, it will create 2 files in your current directory : | ||
|
|
||
| - `neo-privnet.wallet` : a wallet you can use with neo-python | ||
| - `neo-privnet.wif` : a wif private key you can import into other clients (neo-gui for exemple). |
There was a problem hiding this comment.
remove whitespace before colon. also exemple should be example.
fixed typo remove unnecessary whitespaces
Fixed code markup Added blank line That should be it!
README.md
Outdated
| @@ -36,11 +35,17 @@ You can now claim the initial NEO and GAS: | |||
|
|
|||
| `./create_wallet` will display several internal error messages, which is expected as long as at the end you still get a success message. | |||
|
|
|||
| If you call `./create_wallet.sh` or `./docker_run_and_create_wallet.sh`, it will create 2 files in your current directory : | |||
There was a problem hiding this comment.
remove the space before the colon here please.
There was a problem hiding this comment.
I will, hope you didn't mind the extra work, will do better next time =)
README.md
Outdated
| - `neo-privnet.wallet`: a wallet you can use with neo-python | ||
| - `neo-privnet.wif`: a wif private key you can import into other clients (neo-gui for example). | ||
|
|
||
| Those files will get you access to the wallet containing all the NEOs of your private network. |
There was a problem hiding this comment.
"all the NEO and GAS for your private network" please
There was a problem hiding this comment.
Technically, the printed output is :
Finished, Ae9MUYt44Le4ux2Hcd8JEnDpfacN7xQCgD should now own all the NEO on the private network.
Then it claims 48 Gas :
Claiming the GAS...
Will make claim for 48.0 GAS
|
made 2 last comments, then we can merge |
Removed blank space before colon, fixed wording
Added details on how to access the created wallet when using "./create_wallet.sh" or "./docker_run_and_create_wallet.sh".
Added details on how to get your docker-machine IP (It doesn't work with localhost or if you use the docker container IP).
Added a note about copying the wallets from docker image to gui (It's not necessary if you use the commands above).