From b90626021bbaa93adb60834b930bacc8b995d1e5 Mon Sep 17 00:00:00 2001
From: "Wladimir J. van der Laan" <laanwj@gmail.com>
Date: Sun, 15 May 2011 20:11:58 +0200
Subject: [PATCH] add readme file

---
 README.rst | 33 ++++++++++++++++++
 TODO       | 98 ------------------------------------------------------
 2 files changed, 33 insertions(+), 98 deletions(-)
 create mode 100644 README.rst
 delete mode 100644 TODO

diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..ef33af073
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,33 @@
+Bitcoin-qt: Qt4 based GUI replacement for Bitcoin
+=================================================
+
+**Warning** **Warning** **Warning**
+Pre-alpha stuff! Developer only!
+
+This has been implemented:
+
+- qmake / QtCreator project (.pro)
+
+- All dialogs (main GUI, address book, send coins) and menus
+
+- Taskbar icon/menu
+
+- GUI only functionality (copy to clipboard, select address, address/transaction filter proxys)
+
+- Bitcoin core is made compatible with Qt4, and linked against
+
+- Send coins dialog: address and input validation
+
+- Address book and transactions views
+
+This has to be done:
+
+- Further integration of bitcoin core, so that it can actually connect
+  to the network, send commands and get feedback
+
+- Address book and transactions models: so that 
+  something sensible is shown instead of dummy data :)
+
+- Internationalization (convert WX language files)
+
+- Build on Windows
diff --git a/TODO b/TODO
deleted file mode 100644
index 3136696ff..000000000
--- a/TODO
+++ /dev/null
@@ -1,98 +0,0 @@
-Toolbar:
-  Send coins
-  Address book
-
-- "Your bitcoin address" label
-- address field
-- "New..."
-- Copy to Clipboard
-
-Balance: XXX 
-
-Tabs:
-    All transactions
-    Sent/Received
-    Sent
-    Received
-
-Table [columns]:
-    Status
-    Date
-    Description
-    Debit
-    Credit
-
-    ** Table should be the same in all tabs. Do we really need different widgets?
-       -> yes, to have different proxy views
-
-    ** Table rows are much too high?
-
-Status bar:
-  Permanent status indicators:
-    < actions_crystal_project: connect_established.png / connect_no.png >
-  N connections
-  M blocks
-  O transactions
-
-SendCoinDialog
-AddressesDialog (Address book)
-    Receiving/Sending
-
-OptionsDialog
-    Tabs at the left
-AboutDialog
-
-
-- Move resources to res/
-
-  - Send icon
-
-  - Address Book icon
-
-- Translation
-
-- Toolbar icon
-
-- 'notify' on incoming transaction
-
-- AddressTableModel
-  - Name / Label
-  - Address
-  - Delete / Copy to clipboard based on tab
-
-- Make icon blend into taskbar and maybe silver/grey
-  Same for the other icons?
-
-
-Done:
-
-To be able to make an external GUI, I am working on modularizing bitcoin into a library. This is basic code
-plumbing, 100% no functional changes.
-
-- Put guard statements around header files.
-
-- Removed macro foreach: conflicts with Qt4 keyword `foreach`, replaced with BOOST_FOREACH.
-
-- Prefix stdlib structures and functions with std:: in headers; "using namespace" in header files is
-   generally frowned upon. These are moved to the implementation files.
-
-- Modularity: base48.h and most other header files can now be included without the other shebang
-   (useful for linking external GUI to bitcoin core, part of GUI separation).
-  The include files that need each other now include each other.
-
-
-Todo:
-
-- Repeated in all files?
-#define __STDC_LIMIT_MACROS // to enable UINT64_MAX from stdint.h
-#include "main.h"
-#ifndef GUI
-#include "noui.h"
-#endif
-
-- Check windows support / cross platform
-
-Check send dialog:
-    1MCwBbhNGp5hRm5rC1Aims2YFRe2SXPYKt
-
-