From c4c2b0fb269771b13058d43af4c1c3b9276f7f7b Mon Sep 17 00:00:00 2001 From: Tobias Sing Date: Sat, 12 Jun 2021 16:20:25 +0200 Subject: [PATCH 01/18] fixed broken link to HWI usage docs --- 07_3_Integrating_with_Hardware_Wallets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/07_3_Integrating_with_Hardware_Wallets.md b/07_3_Integrating_with_Hardware_Wallets.md index 5426a2a..7668fd7 100644 --- a/07_3_Integrating_with_Hardware_Wallets.md +++ b/07_3_Integrating_with_Hardware_Wallets.md @@ -10,7 +10,7 @@ You have three options for moving through this chapter on hardware wallets: (1) > :warning: **VERSION WARNING:** PSBTs are an innovation from Bitcoin Core v 0.17.0. Earlier versions of Bitcoin Core will not be able to work with the PSBT while it is in progress (though they will still be able to recognize the final transaction). The HWI interface appeared in Bitcoin Core v 0.18.0, but as long as you are using our suggested setup with Bitcoin Standup, it should work. -The methodology described in this chapter for integrating with a hardware wallet depends on the [Bitcoin Hardware Wallet Interface](https://github.com/bitcoin-core/HWI) released through Bitcoin Core and builds on the [installation](https://github.com/bitcoin-core/HWI/blob/master/README.md) and [usage](https://github.com/bitcoin-core/HWI/blob/master/docs/bitcoin-core-usage.md) instructions found there. +The methodology described in this chapter for integrating with a hardware wallet depends on the [Bitcoin Hardware Wallet Interface](https://github.com/bitcoin-core/HWI) released through Bitcoin Core and builds on the [installation](https://github.com/bitcoin-core/HWI/blob/master/README.md) and [usage](https://hwi.readthedocs.io) instructions found there. > :warning: **FRESHNESS WARNING:** The HWI interface is very new and raw around the edges as of Bitcoin Core v 0.20.0. It may be hard to install correctly, and it may have unintuitive errors. What follows is a description of a working setup, but it took several tries to get it right, and your setup may vary. From a8516ee36e3ad02947ee3d7794e51d2d380bf376 Mon Sep 17 00:00:00 2001 From: Ian Culp <57159226+icculp@users.noreply.github.com> Date: Sun, 13 Jun 2021 11:54:35 -0500 Subject: [PATCH 02/18] Initial Setup, Step 4, increased clarity on version It is not clear until chapter 3 that the remainder of the tutorial will assume we chose a pruned testnet. When I first did the setup I used a pruned mainnet, and thus by chapter 3 I had to rebuild the node so that I could better follow along. In retrospect it might seem apparent from the warning about using real funds in earlier paragraphs, but to reduce any confusion it should be elucidated here. --- 02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md b/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md index e813ba8..e91bc10 100644 --- a/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md +++ b/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md @@ -50,7 +50,7 @@ You're now ready to create a node based on the Stackscript. * **Fully Qualified Hostname.** If you're going to include this VPS as part of a network with full DNS records, type in the hostname with its domain. For example, "mybtctest.mydomain.com". Otherwise, just repeat the short hostname and add ".local", for example "mybtctest.local". 3. Enter the password for the "standup" user. 4. Choose an Installation Type in the advanced options. - * **Installation Type.** This is likely "Mainnet" or "Pruned Mainnet" if you are setting up a node for usage and "Testnet" or "Pruned Testnet" if you're just playing around. See the [Synopsis](#synopsis-bitcoin-installation-types) for more information on these options. (Note that if you plan to try out the Lightning chapters, you'll probably want to use an Unpruned node, as working with Pruned nodes on Lightning is iffy. See [§18.1](18_1_Verifying_Your_Lightning_Setup.md#compiling-the-source-code) for the specifics.) + * **Installation Type.** This is likely "Mainnet" or "Pruned Mainnet" if you are setting up a node for usage and "Testnet" or "Pruned Testnet" if you're just playing around. The bulk of this tutorial will assume you chose "Pruned Testnet", but you should still be able to follow along with other types. See the [Synopsis](#synopsis-bitcoin-installation-types) for more information on these options. (Note that if you plan to try out the Lightning chapters, you'll probably want to use an Unpruned node, as working with Pruned nodes on Lightning is iffy. See [§18.1](18_1_Verifying_Your_Lightning_Setup.md#compiling-the-source-code) for the specifics.) 5. Fill in any other appropriate advanced options. * **X25519 Public Key.** This is a public key to add to Tor's list of authorized clients. If you don't use it, anyone who gets the QR code for your node can access it. You'll get this public key from whichever client you're using to connect to your node. For example, if you use [FullyNoded 2](https://github.com/BlockchainCommons/FullyNoded-2), you can go to its settings and "Export Tor V3 Authentication Public Key" for use here. * **SSH Key.** Copy your local computer's SSH key here; this allows you be able to automatically login in via SSH to the standup account. If you haven't setup an SSH key on your local computer yet, there are good instructions for it on [Github](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/). You may also want to add your SSH key into your Linode LISH (Linode Interactive Shell) by going to your "Linode Home Page / My Preferences / LISH Settings / LISH Keys". Using an SSH key will give you a simpler and safer way to log in to your server. From aa1174727e2d3724e6618f4c4a0c60e5834c4acb Mon Sep 17 00:00:00 2001 From: Ian Culp <57159226+icculp@users.noreply.github.com> Date: Sun, 13 Jun 2021 12:11:35 -0500 Subject: [PATCH 03/18] Fixing links to issues First link takes to issues of a different repo; second link takes to github 404. Replacing links with working versions. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55dc69d..7c370e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,9 +11,9 @@ We love your input! We want to make contributing to this project as easy and tra ## We Develop with Github We use GitHub to host code, to track issues and feature requests, and to accept Pull Requests. -## Report Bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues) +## Report Bugs using Github's [issues](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/issues) -If you find bugs, mistakes, or inconsistencies in this project's code or documents, please let us know by [opening a new issue](./issues), but consider searching through existing issues first to check and see if the problem has already been reported. If it has, it never hurts to add a quick "+1" or "I have this problem too". This helps prioritize the most common problems and requests. +If you find bugs, mistakes, or inconsistencies in this project's code or documents, please let us know by [opening a new issue](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/issues/new), but consider searching through existing issues first to check and see if the problem has already been reported. If it has, it never hurts to add a quick "+1" or "I have this problem too". This helps prioritize the most common problems and requests. ### Write Bug Reports with Detail, Background, and Sample Code From 82c232c49153e9544fdcf30198a0b0073a7adc09 Mon Sep 17 00:00:00 2001 From: Ian Culp <57159226+icculp@users.noreply.github.com> Date: Mon, 14 Jun 2021 16:21:12 -0500 Subject: [PATCH 04/18] Update 02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md minor grammatical fix --- 02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md b/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md index e813ba8..8a0b1c6 100644 --- a/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md +++ b/02_1_Setting_Up_a_Bitcoin-Core_VPS_with_StackScript.md @@ -183,7 +183,7 @@ If all look good, congratulations, you have a functioning Bitcoin node using Lin ## What We Have Wrought -Although the default Debian 10 image that we are using for your VPS has been modified by Linode to be relatively secure, your Bitcoin node as installed through the Linode StackScript is set up with an even high level of security. You may find this limiting, or be unable to do things that you expect. Here are a few notes on that: +Although the default Debian 10 image that we are using for your VPS has been modified by Linode to be relatively secure, your Bitcoin node as installed through the Linode StackScript is set up with an even higher level of security. You may find this limiting, or be unable to do things that you expect. Here are a few notes on that: ### Protected Services From 2674bdec2cdd00029622ff3d081754b5f8a0a526 Mon Sep 17 00:00:00 2001 From: Ian Culp <57159226+icculp@users.noreply.github.com> Date: Tue, 15 Jun 2021 11:48:57 -0500 Subject: [PATCH 05/18] amount consistency; faucet return; tx fees Since the amount below the #Examine Your Transaction amounts to 0.001, the command to send should be the same amount for consistency Adding a note about faucet return to remind user to try to use the faucet return address of the faucet they used to receive transactions in the earlier portion of the tutorial, to help keep alive the faucet services. Adding a note about adjusting amounts based on current balance and to account for the transaction fee. --- 04_1_Sending_Coins_The_Easy_Way.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/04_1_Sending_Coins_The_Easy_Way.md b/04_1_Sending_Coins_The_Easy_Way.md index 0ba91e7..715e343 100644 --- a/04_1_Sending_Coins_The_Easy_Way.md +++ b/04_1_Sending_Coins_The_Easy_Way.md @@ -40,14 +40,19 @@ You need somewhere to send your coins to. Usually, someone would send you an add You're now ready to send some coins. This is actually quite simple via the command line. You just use `bitcoin-cli sendtoaddress [address] [amount]`. So, to send a little coinage to the address `n2eMqTT929pb1RDNuqEnxdaLau1rxy3efi` just requires: ``` -$ txid=$(bitcoin-cli sendtoaddress n2eMqTT929pb1RDNuqEnxdaLau1rxy3efi 0.1) +$ txid=$(bitcoin-cli sendtoaddress n2eMqTT929pb1RDNuqEnxdaLau1rxy3efi 0.001) $ echo $txid 93250d0cacb0361b8e21030ac65bc4c2159a53de1075425d800b2d7a8ab13ba8 ``` + +> 🙏 To help keep testnet faucets alive, try to use the return address of the same faucet you used in the previous chapter on receiving transactions. + Make sure the address you write in is where you want the money to go. Make _double_ sure. If you make mistakes in Bitcoin, there's no going back. You'll receive a txid back when you issue this command. +> ❕ You may end up with an error code if you don't have enough funds in your wallet to send the transaction. Depending on your current balance `bitcoin-cli getbalance` you may need to adjust the amount to be sent to account for the amount being sent along with the transaction fee. If your current balance is 0.001, then you could try sending 0.0001. Alternatively, it would be better to instead subtract the expected fee given in the error message from your current balance. This is good practice as many wallets expect you to calculate your own amount + fees when withdrawing, even among popular exchanges. + > :warning: **WARNING:** The `bitcoin-cli` command actually generates JSON-RPC commands when it's talking to the bitcoind. They can be really picky. This is an example: if you list the bitcoin amount without the leading zero (i.e. ".1" instead of "0.1"), then bitcoin-cli will fail with a mysterious message. > :warning: **WARNING:** Even if you're careful with your inputs, you could see "Fee estimation failed. Fallbackfee is disabled." Fundamentally, this means that your local `bitcoind` doesn't have enough information to estimate fees. You should really never see it if you've waited for your blockchain to sync and set up your system with Bitcoin Standup. But if you're not entirely synced, you may see this. It also could be that you're not using a standard `bitcoin.conf`: the entry `blocksonly=1` will cause your `bitcoind` to be unable to estimate fees. From 62ae49fd0b628e97ac8dab17ac4e7563f7b9ade9 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 07:48:18 -1000 Subject: [PATCH 06/18] Update TODO-30.md --- TODO-30.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/TODO-30.md b/TODO-30.md index 6d11cbf..9ef96cf 100644 --- a/TODO-30.md +++ b/TODO-30.md @@ -4,22 +4,23 @@ The following TODO items are intended for a 3.0 version of Learning Bitcoin from 1. 0.21 Additions * New Wallet. See: https://bitcoin.stackexchange.com/questions/101767/dumpwallet-output-documentation-explanation -3. Animated GIFs for key CLI demos (probably https://github.com/faressoft/terminalizer but there are others) -4. Section on Libwally Shim for Swift -5. Section on Wolf's Bitcoin Lib for Swift -6. Full example of creating a PSBT, handing it to Libwally, and signing it -7. Miniscript -8. More complex descriptors -9. Schnorr (2021) -10. Other BCC Command-Line Utilities? +1. Animated GIFs for key CLI demos (probably https://github.com/faressoft/terminalizer but there are others) +1. Section on Libwally Shim for Swift +1. Section on Wolf's Bitcoin Lib for Swift +1. Full example of creating a PSBT, handing it to Libwally, and signing it +1. Miniscript +1. More complex descriptors +1. Schnorr (2021) +1. Other BCC Command-Line Utilities? * seedtool * keytool * bytewords-cli -11. Interlude on QR production +1. Interlude on QR production * QuickConnect QR * UR/Animated QR -12. Programming Lightning with C +1. Programming Lightning with C * _Some good docs from one of the developers are here: https://diyhpl.us/wiki/transcripts/blockstream-webinars/2019-07-31-rusty-russell-getting-started-with-c-lightning/._ * _Other potential docs: https://twitter.com/roasbeef/status/1389649064753471488_ -13. Consider TIme Lock Discussion Improvements +1. Consider TIme Lock Discussion Improvements * Especially look at chart in https://prestwi.ch/bitcoin-time-locks/ +1. Taproot (August/November) From 0f9a7859e9b7af94fd4848fb5b2972a4f711bcc2 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:07:34 -1000 Subject: [PATCH 07/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index da220d5..3ba0d5c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Learning Bitcoin from the Command Line 2.0.1 +# Learning Bitcoin from the Command Line 2.0.2 ### _by Christopher Allen and Shannon Appelcline_ ![](https://www.blockchaincommons.com/images/projects/lbtc-screen.png) From e8a45e5f050c8d6cc607113d6b9ccdc0ee2d5d38 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:09:29 -1000 Subject: [PATCH 08/18] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3ba0d5c..da220d5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Learning Bitcoin from the Command Line 2.0.2 +# Learning Bitcoin from the Command Line 2.0.1 ### _by Christopher Allen and Shannon Appelcline_ ![](https://www.blockchaincommons.com/images/projects/lbtc-screen.png) From 50119027607a475a10859807250d25b897a5aff2 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:13:38 -1000 Subject: [PATCH 09/18] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index da220d5..9ee8172 100644 --- a/README.md +++ b/README.md @@ -163,6 +163,8 @@ To financially support further development of `$projectname` and other projects, We encourage public contributions through issues and pull requests! Please review [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our development process. All contributions to this repository require a GPG signed [Contributor License Agreement](./CLA.md). +if you would like to provide a translation of Learning Bitcoin into another language, please additionally see [TRANSLATING.md](./TRANSLATING.md). + ### Discussions The best place to talk about Blockchain Commons and its projects is in our GitHub Discussions areas. From 26ddb69bc82d55f2f73b79d86caf0e4f01c19954 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:19:57 -1000 Subject: [PATCH 10/18] Create TRANSLATING.md --- TRANSLATING.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 TRANSLATING.md diff --git a/TRANSLATING.md b/TRANSLATING.md new file mode 100644 index 0000000..da77a95 --- /dev/null +++ b/TRANSLATING.md @@ -0,0 +1,3 @@ +# Translating Learning Bitcoin from the Command Line + +Thank you for your interest in translating Learning Bitcoin from the Command Line! What follows is our standard procedure for doing so. If you have any questions, please file an Issue. From e000664dd26f17a47479360c205cb0a207275731 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:47:22 -1000 Subject: [PATCH 11/18] draft text --- TRANSLATING.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/TRANSLATING.md b/TRANSLATING.md index da77a95..5f750eb 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -1,3 +1,30 @@ # Translating Learning Bitcoin from the Command Line Thank you for your interest in translating Learning Bitcoin from the Command Line! What follows is our standard procedure for doing so. If you have any questions, please file an Issue. + +1. **Please Follow Our Normal Contribution Procedure.** + * Read over [Contributing.md](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/blob/master/CONTRIBUTING.md). + * Fill out a [Contributor License Agreement](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/blob/master/CLA.md) and submit it as a PR. +1. **Choose a Release.** + * Choose a [Release](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/releases) as the basis of your translation. We generally suggest the latest release. This will ensure the consistency of all the files in your translation, will insulate you from any changes we make, and will make it easy to see what has changed when we make a new release. + * Label your table of contents and each chapter or section with the release used. +1. **Create a Branch.** + * All work should be done in a branch, with work being submitted to the `master` branch as PRs. +1. **Create a Directory.** + * Create a top-level directory for your complete translation using the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), for example `es` (Spanish), `fr` (French), or `pt` (Portuguese). +1. **Submit PRs a Chapter at a Time.** + * Submit your PRs for the translation in batches of no more than a single chapter at a time. + * Submit in smaller batches if it makes sense, for example because different people are writing different sections. +1. **Request Approval from a Native Speaker.** + * No one can ever do a great edit of their own work, so we require each section to be approved by someone other than the original translator. + * This fundamentally means that any translation team _should_ have at least two members, either one translator and one editor or else two people who trade off roles of translator and editor. If your team doesn't have a second member, we can put out a call for an editor/approver when you submit a PR, but it's possible that we won't be able to find one, and your hard work will languish, so it's s better to have one up front. +1. **Request Approval from the Blockchain Commons Team.** + * Once a chapter or section has been approved by a native speaker, request approval from someone on the Blockchain Commons team: currently [@shannona](https://github.com/shannona). +1. **Continue!** + * Continue through the process, no more than one chapter at a time, until you have a full book. + * Be aware of the scope of the overall project. As of v2.01, Learning Bitcoin from the Command Line is 120,000 words in length. As a book, that'd be 250-400 pages, depending on the format and layout. You want to make sure you have the time for that level of commitment before getting started. +1. **Update Your Translation with New Releases** + * It is our hope that translations will stay up to day with new releases, particularly major and minor releases, which are likely to include new content and updates. + * If you have decided to stop updating a translation, please let us know in an Issue, so that we can let the community know that we are looking for a new translator to continue updating a translation. + +Again, thank you! From f33d5539d8afee820baf1907444d5d59f5e5b0d9 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:57:00 -1000 Subject: [PATCH 12/18] Update TRANSLATING.md --- TRANSLATING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 5f750eb..106e5f9 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -2,11 +2,11 @@ Thank you for your interest in translating Learning Bitcoin from the Command Line! What follows is our standard procedure for doing so. If you have any questions, please file an Issue. -1. **Please Follow Our Normal Contribution Procedure.** +1. **Please Follow Our Normal Contributor Procedure.** * Read over [Contributing.md](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/blob/master/CONTRIBUTING.md). * Fill out a [Contributor License Agreement](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/blob/master/CLA.md) and submit it as a PR. 1. **Choose a Release.** - * Choose a [Release](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/releases) as the basis of your translation. We generally suggest the latest release. This will ensure the consistency of all the files in your translation, will insulate you from any changes we make, and will make it easy to see what has changed when we make a new release. + * Choose a [Release](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/releases) as the basis of your translation. We generally suggest the latest release. This will ensure the consistency of all the files in your translation, will insulate you from any changes we make, and will make it easy to see what has changed when we create a new release. * Label your table of contents and each chapter or section with the release used. 1. **Create a Branch.** * All work should be done in a branch, with work being submitted to the `master` branch as PRs. @@ -17,14 +17,14 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin * Submit in smaller batches if it makes sense, for example because different people are writing different sections. 1. **Request Approval from a Native Speaker.** * No one can ever do a great edit of their own work, so we require each section to be approved by someone other than the original translator. - * This fundamentally means that any translation team _should_ have at least two members, either one translator and one editor or else two people who trade off roles of translator and editor. If your team doesn't have a second member, we can put out a call for an editor/approver when you submit a PR, but it's possible that we won't be able to find one, and your hard work will languish, so it's s better to have one up front. + * This fundamentally means that any translation team _should_ contain at least two members, either one translator and one editor or else two people who trade off roles of translator and editor. If your team doesn't have a second member, we can put out a call for an editor/approver when you submit a PR, but it's possible that we won't be able to find one, and your hard work will languish, so it's s better to have one up front. 1. **Request Approval from the Blockchain Commons Team.** * Once a chapter or section has been approved by a native speaker, request approval from someone on the Blockchain Commons team: currently [@shannona](https://github.com/shannona). 1. **Continue!** * Continue through the process, no more than one chapter at a time, until you have a full book. * Be aware of the scope of the overall project. As of v2.01, Learning Bitcoin from the Command Line is 120,000 words in length. As a book, that'd be 250-400 pages, depending on the format and layout. You want to make sure you have the time for that level of commitment before getting started. 1. **Update Your Translation with New Releases** - * It is our hope that translations will stay up to day with new releases, particularly major and minor releases, which are likely to include new content and updates. + * It is our hope that translations will stay up to day with new releases, particularly major and minor releases, which are likely to include new content and updates. Currently, these only occur ever few years * If you have decided to stop updating a translation, please let us know in an Issue, so that we can let the community know that we are looking for a new translator to continue updating a translation. Again, thank you! From 1c0ca8ad3227c1366852d666f0588f5641417dd1 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 09:57:45 -1000 Subject: [PATCH 13/18] Create README.md --- es/README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 es/README.md diff --git a/es/README.md b/es/README.md new file mode 100644 index 0000000..bee8b79 --- /dev/null +++ b/es/README.md @@ -0,0 +1 @@ +_initial file for Spanish translation of learning Bitcoin from the Command Line._ From c736c1ce77eae48d5abf64d89c791bf4c8ec12b6 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 10:01:55 -1000 Subject: [PATCH 14/18] Update TRANSLATING.md --- TRANSLATING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/TRANSLATING.md b/TRANSLATING.md index 106e5f9..0d38c17 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -7,6 +7,7 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin * Fill out a [Contributor License Agreement](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/blob/master/CLA.md) and submit it as a PR. 1. **Choose a Release.** * Choose a [Release](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/releases) as the basis of your translation. We generally suggest the latest release. This will ensure the consistency of all the files in your translation, will insulate you from any changes we make, and will make it easy to see what has changed when we create a new release. + * If it looks like there hasn't been a new Release in a while, file an Issue saying you're interested in starting a new translation, and asking if it would make sense for there to be a new Release milestone before you do so. If there's been anything notable, and we're not in the middle of things, we'll likely create a new patch or minor version. If we're in the middle of things, we'll just suggest you use the previous Release. * Label your table of contents and each chapter or section with the release used. 1. **Create a Branch.** * All work should be done in a branch, with work being submitted to the `master` branch as PRs. From b5677ca649d0c19d2a3e7ff0c745ebfa819a4bfb Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 10:08:57 -1000 Subject: [PATCH 15/18] Update TRANSLATING.md --- TRANSLATING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 0d38c17..0b786a9 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -23,7 +23,7 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin * Once a chapter or section has been approved by a native speaker, request approval from someone on the Blockchain Commons team: currently [@shannona](https://github.com/shannona). 1. **Continue!** * Continue through the process, no more than one chapter at a time, until you have a full book. - * Be aware of the scope of the overall project. As of v2.01, Learning Bitcoin from the Command Line is 120,000 words in length. As a book, that'd be 250-400 pages, depending on the format and layout. You want to make sure you have the time for that level of commitment before getting started. + * Be aware of the scope of the overall project. As of v2.01, Learning Bitcoin from the Command Line is 120,000 words in length. As a book, that'd be 250-400 pages, depending on the format and layout. (About 80,000 words of that is text to translate, with the remainder being code.) You want to make sure you have the time for that level of commitment before getting started. 1. **Update Your Translation with New Releases** * It is our hope that translations will stay up to day with new releases, particularly major and minor releases, which are likely to include new content and updates. Currently, these only occur ever few years * If you have decided to stop updating a translation, please let us know in an Issue, so that we can let the community know that we are looking for a new translator to continue updating a translation. From 44b84b599885cfbc63605f43b148b49ddb1b2572 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 10:34:12 -1000 Subject: [PATCH 16/18] Delete es directory --- es/README.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 es/README.md diff --git a/es/README.md b/es/README.md deleted file mode 100644 index bee8b79..0000000 --- a/es/README.md +++ /dev/null @@ -1 +0,0 @@ -_initial file for Spanish translation of learning Bitcoin from the Command Line._ From 4fdae44c5c780cc767edd306ddd8cabc71325586 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Tue, 15 Jun 2021 10:43:08 -1000 Subject: [PATCH 17/18] updated to explain translation branch --- TRANSLATING.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 0b786a9..cb68af5 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -9,12 +9,14 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin * Choose a [Release](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/releases) as the basis of your translation. We generally suggest the latest release. This will ensure the consistency of all the files in your translation, will insulate you from any changes we make, and will make it easy to see what has changed when we create a new release. * If it looks like there hasn't been a new Release in a while, file an Issue saying you're interested in starting a new translation, and asking if it would make sense for there to be a new Release milestone before you do so. If there's been anything notable, and we're not in the middle of things, we'll likely create a new patch or minor version. If we're in the middle of things, we'll just suggest you use the previous Release. * Label your table of contents and each chapter or section with the release used. -1. **Create a Branch.** - * All work should be done in a branch, with work being submitted to the `master` branch as PRs. -1. **Create a Directory.** - * Create a top-level directory for your complete translation using the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), for example `es` (Spanish), `fr` (French), or `pt` (Portuguese). +1. **Request a Branch.** + * File an [Issue](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/issues) requesting a new branch for your translation + * This will be the master place for us to collect work on the translation over time. + * We will create a top-level directory for your complete translation using the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), for example `es` (Spanish), `fr` (French), or `pt` (Portuguese). Work should be done in that directory. +1. **Branch the Branch.** + * Once we've created a translation branch, you'll then want to branch that into your own GitHub account. 1. **Submit PRs a Chapter at a Time.** - * Submit your PRs for the translation in batches of no more than a single chapter at a time. + * Submit your PRs for the translation from your working branch to our translation branch in batches of no more than a single chapter at a time. * Submit in smaller batches if it makes sense, for example because different people are writing different sections. 1. **Request Approval from a Native Speaker.** * No one can ever do a great edit of their own work, so we require each section to be approved by someone other than the original translator. @@ -24,6 +26,9 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin 1. **Continue!** * Continue through the process, no more than one chapter at a time, until you have a full book. * Be aware of the scope of the overall project. As of v2.01, Learning Bitcoin from the Command Line is 120,000 words in length. As a book, that'd be 250-400 pages, depending on the format and layout. (About 80,000 words of that is text to translate, with the remainder being code.) You want to make sure you have the time for that level of commitment before getting started. +1. **Let Us Know When You're Done.** + * When you've completed your translation, file an issue to let us know that the translation branch is ready to be merged into the master. + * This will also let us know to announce the completed translation and link it into the master README 1. **Update Your Translation with New Releases** * It is our hope that translations will stay up to day with new releases, particularly major and minor releases, which are likely to include new content and updates. Currently, these only occur ever few years * If you have decided to stop updating a translation, please let us know in an Issue, so that we can let the community know that we are looking for a new translator to continue updating a translation. From a47fd6ef3938db63149a227efd35125e8d28a7c8 Mon Sep 17 00:00:00 2001 From: Shannon Appelcline Date: Wed, 16 Jun 2021 15:21:29 -1000 Subject: [PATCH 18/18] Update TRANSLATING.md --- TRANSLATING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index cb68af5..2d3c16b 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -13,10 +13,10 @@ Thank you for your interest in translating Learning Bitcoin from the Command Lin * File an [Issue](https://github.com/BlockchainCommons/Learning-Bitcoin-from-the-Command-Line/issues) requesting a new branch for your translation * This will be the master place for us to collect work on the translation over time. * We will create a top-level directory for your complete translation using the [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), for example `es` (Spanish), `fr` (French), or `pt` (Portuguese). Work should be done in that directory. -1. **Branch the Branch.** - * Once we've created a translation branch, you'll then want to branch that into your own GitHub account. +1. **Fork the Branch.** + * Once we've created a translation branch, you'll then want to fork that into your own GitHub account. 1. **Submit PRs a Chapter at a Time.** - * Submit your PRs for the translation from your working branch to our translation branch in batches of no more than a single chapter at a time. + * Submit your PRs for the translation from your working fork to our translation branch in batches of no more than a single chapter at a time. * Submit in smaller batches if it makes sense, for example because different people are writing different sections. 1. **Request Approval from a Native Speaker.** * No one can ever do a great edit of their own work, so we require each section to be approved by someone other than the original translator.