Copyright (C) 2019  Asher Gordon <AsDaGo@protonmail.ch>

Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved.  This file is offered as-is,
without any warranty.

                             ____              
                         ___|___ \ _ __  _   _ 
                        / __| __) | '_ \| | | |
                       | (__ / __/| |_) | |_| |
                        \___|_____| .__/ \__, |
                                  |_|    |___/ 
======================================================================

C2py (spelled "c2py", but the "c"  may be capitalized at the beginning
of a  sentence such  as this  one) converts cpy  code to  python code,
possibly running it.   Cpy has a syntax similar to  C (that means very
minimal white-space  dependency!)  but  with the  ease and  power that
comes with Python.


So how do I use this "c2py" thingy, then?
=========================================

Usage is  very simple and intuitive.   To run a cpy  program, you must
simply run

  $ c2py PROG.cpy

where PROG.cpy is  your program. C2py can also compile  to Python code
without executing it. To do so, run

  $ c2py -o OUT.py PROG.cpy

where OUT.py is  the output Python file and PROG.cpy  is the cpy file.
You  can also  minify  the output  with `-O'  and  make it  executable
(including the #!) with `-!'. Run

  $ c2py --help

for more info.


Alright, but I can't use it without  installing it first!  How do I do
that?
======================================================================

Simply run

  $ ./configure && make && sudo make install

as you would for most programs.  See the file `INSTALL' for more info.


Can I use c2py interactively as I would for Python?
===================================================

Definitely!   If  you  run  c2py  with  no  arguments,  it  starts  in
interactive mode by default if you're  on a TTY.  You can also specify
interactive mode explicitly with `-i'.

For  the  best experience  with  interactive  mode, the  GNU  Readline
development  library  and the  Python  development  library should  be
present at compile  time.  On a Debian system, these  can be installed
with

  $ sudo apt install libreadline-dev libpython3-dev

`pkg-config' is required to detect  the Python development library, so
you will also need to install that with

  $ sudo apt install pkg-config


Is c2py stable?
===============

Not yet.   Hopefully it  will be soon,  but for now  it's as  buggy as
Maine in June. (Hey, that rhymes!)


Help! I've found a bug! PANIC!!!!!
==================================

Calm down.  It  is quite possible you have found  a bug.  Please check
the error  message (if any) and  see if it  is actually a bug  in your
code.   If you  believe it  is  a bug  in  c2py, please  report it  at
https://savannah.nongnu.org/bugs/?func=additem&group=c2py         (the
preferred  way) or  send a  bug report  to <c2py-bug@nongnu.org>.   If
possible, include a backtrace and/or a core dump.


Where is the documentation?
===========================

Documentation is very  limited for now.  You can run  `c2py --help' to
get a summary of command-line  options, and the language itself should
be  pretty intuitive  assuming  you already  know  Python and  another
language with a C-like syntax.

Python documentation can be  found at <https://docs.python.org> or can
be installed locally on a Debian system with

  $ sudo apt install python3-doc
