README

   1 Dogecode
   2 ========
   3
   4 Rob Myers <rob@robmyers.org>
   5 Brainfuck interpreter by Sebastian Kaspari under the WTFPL.
   6
   7 A system for representing and running programs as Dogeparty tokens.
   8
   9 Read the whitepaper in doc/ for details of how the system works now and how it is planned to be extended.
  10
  11 Installation
  12 ============
  13
  14 Run the following command in the console with root permission:
  15
  16 python setup.py install
  17
  18 Usage
  19 =====
  20
  21 To compile a program, run e.g.:
  22
  23 dcc -o test.csv hello-world.bf
  24
  25 This will convert the Brainfuck code to a csv file of token runs.
  26
  27 To upload a program, run e.g.:
  28
  29 dcsend -u rpcuser -w rpcpassword FROMADDRESS TOADDRESS hello-world.csv
  30
  31 You must control FROMADDRESS, and TOADDRESS should be a newly created address with no existing asset tokens attached. You should also probably control it.
  32
  33 Sending will take a very long time (see the whitepaper), and will transfer lots of tokens from FROMADDRESS. Make sure you got the addresses right and that the program ran OK when tested locally by dcc. And don't quit dcsend, restarting is not yet supported.
  34
  35 To execute a program, run e.g.:
  36
  37 dcrun -u rpcuser -w rpcpassword TOADDRESS
  38
  39 This will fetch the program from TOADDRESS, run it locally, and output the results (if any) to the console.
  40
  41 Warning
  42 =======
  43
  44  Be careful when writing and uploading Dogecode programs. You are responsible for ensuring that programs run as expected and that you send the correct tokens to the correct addresses.
  45