neobytes-project/neobytes
neobytes-project/neobytes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update and reformat README.md

Browse Source 
* updated references to files which have since been moved
* added reference to licensing
* added brief summary in case a non-technical user happens upon repo first
* miscellaneous Markdown-isms to make the doc more attractive
* remove unused symlink README -> README.md

I double-checked the makefiles and whatnot to ensure that the README symlink is
not being referenced. It is not. Rather, `doc/README` and
`doc/README_windows.txt` are copied for distribution.
This commit is contained in:
Colin Dean 2012-12-12 21:27:58 -05:00
parent 5b989722be
commit 20d5945505
2 changed files with 63 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README
View File

@ -1 +0,0 @@
README.md

110
README.md
View File

@ -1,66 +1,82 @@
Bitcoin integration/staging tree Bitcoin integration/staging tree
================================
http://www.bitcoin.org
Copyright (c) 2009-2012 Bitcoin Developers
What is Bitcoin?
----------------
Bitcoin is an experimental new digital currency that enables instant payments to
anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate
with no central authority: managing transactions and issuing money are carried
out collectively by the network. Bitcoin is also the name of the open source
software which enables the use of this currency.
For more information, as well as an immediately useable, binary version of
the Bitcoin client sofware, see http://www.bitcoin.org.
License
-------
Bitcoin is released under the terms of the MIT license. See `COPYING` for more
information or see http://opensource.org/licenses/MIT.
Development process Development process
=================== -------------------
Developers work in their own trees, then submit pull requests when Developers work in their own trees, then submit pull requests when they think
they think their feature or bug fix is ready. their feature or bug fix is ready.
If it is a simple/trivial/non-controversial change, then one of the If it is a simple/trivial/non-controversial change, then one of the Bitcoin
bitcoin development team members simply pulls it. development team members simply pulls it.
If it is a more complicated or potentially controversial If it is a *more complicated or potentially controversial* change, then the patch
change, then the patch submitter will be asked to start a submitter will be asked to start a discussion (if they haven't already) on the
discussion (if they haven't already) on the mailing list: [mailing list](http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development).
http://sourceforge.net/mailarchive/forum.php?forum_name=bitcoin-development
The patch will be accepted if there is broad consensus that it is a The patch will be accepted if there is broad consensus that it is a good thing.
good thing. Developers should expect to rework and resubmit patches Developers should expect to rework and resubmit patches if the code doesn't
if they don't match the project's coding conventions (see coding.txt) match the project's coding conventions (see `doc/coding.txt`) or are
or are controversial. controversial.
The master branch is regularly built and tested, but is not guaranteed The `master` branch is regularly built and tested, but is not guaranteed to be
to be completely stable. Tags are regularly created to indicate new completely stable. [Tags](https://github.com/bitcoin/bitcoin/tags) are created
official, stable release versions of Bitcoin. regularly to indicate new official, stable release versions of Bitcoin.
Testing Testing
======= -------
Testing and code review is the bottleneck for development; we get more Testing and code review is the bottleneck for development; we get more pull
pull requests than we can review and test. Please be patient and help requests than we can review and test. Please be patient and help out, and
out, and remember this is a security-critical project where any remember this is a security-critical project where any mistake might cost people
mistake might cost people lots of money. lots of money.
Automated Testing ### Automated Testing
-----------------
Developers are strongly encouraged to write unit tests for new code, Developers are strongly encouraged to write unit tests for new code, and to
and to submit new unit tests for old code. submit new unit tests for old code.
Unit tests for the core code are in src/test/ Unit tests for the core code are in `src/test/`. To compile and run them:
To compile and run them:
cd src; make -f makefile.linux test
Unit tests for the GUI code are in src/qt/test/ cd src; make -f makefile.linux test
To compile and run them:
qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
make -f Makefile.test
./Bitcoin-Qt
Every pull request is built for both Windows and Unit tests for the GUI code are in `src/qt/test/`. To compile and run them:
Linux on a dedicated server, and unit and sanity
tests are automatically run. The binaries
produced may be used for manual QA testing
(a link to them will appear in a comment on the pull request
from 'BitcoinPullTester').
See https://github.com/TheBlueMatt/test-scripts for the
build/test scripts.
Manual Quality Assurance (QA) Testing qmake BITCOIN_QT_TEST=1 -o Makefile.test bitcoin-qt.pro
------------------------------------- make -f Makefile.test
./Bitcoin-Qt
Large changes should have a test plan, and should be tested Every pull request is built for both Windows and Linux on a dedicated server,
by somebody other than the developer who wrote the code. and unit and sanity tests are automatically run. The binaries produced may be
used for manual QA testing -- a link to them will appear in a comment on the
pull request posted by 'BitcoinPullTester'. See `https://github.com/TheBlueMatt/test-scripts`
for the build/test scripts.
See https://github.com/bitcoin/QA/ for how to create a test plan. ### Manual Quality Assurance (QA) Testing
Large changes should have a test plan, and should be tested by somebody other
than the developer who wrote the code.
See `https://github.com/bitcoin/QA/` for how to create a test plan.