doc: Change README_windows to Markdown #14131

pull emilengler wants to merge 4 commits into bitcoin:master from emilengler:readme-windows-in-markdown changing 3 files +21 −26

emilengler commented at 1:25 PM on September 2, 2018: contributor

To make it more coherent with the other README files in the doc/ folder
Change README_windows to Markdown 564360967a
fanquake added the label Docs on Sep 2, 2018
fanquake commented at 1:32 PM on September 2, 2018: member

Please fix any trailing whitespace issues, see linter output here.

You'll also need to update any instances where this file is used, such as in share/setup.nsi.in or Makefile.am.

I'm wondering if there was a Windows specific reason the readme was left as a .txt file?
ken2812221 commented at 1:37 PM on September 2, 2018: contributor

I am not sure it is good to fix the linter issue. When we change \r\n to \n, it will show just one line if it is opened by Windows built-in notepad.
Fixed filename in Makefile and NSI script aa7f6f2016
emilengler commented at 2:01 PM on September 2, 2018: contributor

@fanquake Thanks for that reminder I updated it. I also done grep -rn README_windows.txt to be 100% sure.
Updated NSI script 42cf00ac67
Change line ending d3d73898cc
ken2812221 commented at 2:56 PM on September 2, 2018: contributor

I am NACK about the line ending change thing. IMO it just need to add a file list into the linter to not check \r\n.
MarcoFalke added the label Build system on Sep 4, 2018
fanquake renamed this:
~~Change README_windows to Markdown~~
doc: Change README_windows to Markdown
on Sep 6, 2018
laanwj commented at 1:54 PM on September 6, 2018: member

NACK

Leave it .txt please. This file is intended to be opened in notepad (as it is packaged with the binary distribution), changing the extension/layout does nothing to help windows users.
laanwj closed this on Sep 6, 2018

in doc/README_windows.md:3 in d3d73898cc

  21 | -See the bitcoin wiki at:

  22 | -  https://en.bitcoin.it/wiki/Main_Page

  23 | -for more help and information.

  24 | +# Bitcoin Core
  25 | +
  26 | +### Intro

practicalswift commented at 5:06 AM on September 7, 2018:

doc/README_windows.md:3: MD001 Header levels should only increment by one level at a time

in doc/README_windows.md:9 in d3d73898cc

  27 | +Bitcoin is a free open source peer-to-peer electronic cash system that is
  28 | +completely decentralized, without the need for a central server or trusted
  29 | +parties.  Users hold the crypto keys to their own money and transact directly
  30 | +with each other, with the help of a P2P network to check for double-spending.
  31 | +
  32 | +

practicalswift commented at 5:06 AM on September 7, 2018:

doc/README_windows.md:9: MD012 Multiple consecutive blank lines

in doc/README_windows.md:18 in d3d73898cc

  36 | +Bitcoin Core is the original Bitcoin client and it builds the backbone of the network.
  37 | +However, it downloads and stores the entire history of Bitcoin transactions;
  38 | +depending on the speed of your computer and network connection, the synchronization
  39 | +process can take anywhere from a few hours to a day or more.
  40 | +
  41 | +See the bitcoin wiki [here](https://en.bitcoin.it/wiki/Main_Page) for more help and information.

practicalswift commented at 5:06 AM on September 7, 2018:

doc/README_windows.md:18: MD013 Line length

in doc/README_windows.md:11 in d3d73898cc

  29 | +parties.  Users hold the crypto keys to their own money and transact directly
  30 | +with each other, with the help of a P2P network to check for double-spending.
  31 | +
  32 | +
  33 | +### Setup
  34 | +Unpack the files into a directory and run bitcoin-qt.exe.

practicalswift commented at 5:07 AM on September 7, 2018:

doc/README_windows.md:10: MD022 Headers should be surrounded by blank lines

in doc/README_windows.md:4 in d3d73898cc

  22 | -  https://en.bitcoin.it/wiki/Main_Page

  23 | -for more help and information.

  24 | +# Bitcoin Core
  25 | +
  26 | +### Intro
  27 | +Bitcoin is a free open source peer-to-peer electronic cash system that is

practicalswift commented at 5:08 AM on September 7, 2018:

doc/README_windows.md:3: MD022 Headers should be surrounded by blank lines

MarcoFalke locked this on Sep 8, 2021

Contributors

Labels