From 932f895e5117da4cf0a984163f8d9cc08766ae9d Mon Sep 17 00:00:00 2001 From: Jose Rodriguez Date: Mon, 16 Oct 2017 23:16:34 +0200 Subject: [PATCH] update README.md file Removes .MSI reference, and put clearer instructions. Also adds logo (by @Haplo. Thanks!!) Thanks to @Hark0 for his suggestions. --- README.md | 52 ++++++++++++++++++++++++++++++++++++----------- zxbasic_logo.png | Bin 0 -> 624 bytes 2 files changed, 40 insertions(+), 12 deletions(-) create mode 100644 zxbasic_logo.png diff --git a/README.md b/README.md index 99eea23c4..1a8c8b57e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +![Boriel ZX Basic](./zxbasic_logo.png) + [![Build Status](https://travis-ci.org/boriel/zxbasic.svg?branch=master)](https://travis-ci.org/boriel/zxbasic) ZX BASIC @@ -30,34 +32,60 @@ For help, support, updates meet the community at my forum: -INSTALL -------- +INSTALLATION +------------ Go to the ZXBasic download page -and get the version most suitable for you. +and get the version most suitable for you. + +There are, basically, two flavors (both with identical capabilities): + + - For Windows you can download de win32 executable (Windows .exe zip package) version. +To install just uncompress it in a directory of your choice. +The main executable is `zxb.exe` (more on this later). With this toolchain +also comes `zxbasm.exe` (the assembler) and `zxbpp.exe` (the preprocessor), but these +are not needed when programming in BASIC. -These tools are completely written in python, so you will need a python -interpreter (available on many platforms). Just copy them in a directory of your -hoice and installation is done. :-) + - For Linux and Mac OSX there is a python version, so you will need a python +interpreter (available on many platforms, and usually already installed in Linux and Mac OSX). +Just uncompress it in a directory of your choice and installation is done. :-) +The main executables are `zxb.py` (the compiler), `zxbasm.py` (the assembler) and `zxbpp.py` (the preprocessor). +You can use this version in Windows, but will need to install a python interpreter first. -For Windows users there is also a binary .MSI installation, which does not need -python installed. +##### Examples +|![Eleuterio, el mono serio](http://www.boriel.com/wiki/en/images/a/ab/EleuterioElMonoSerio.gif)|![El Hobbit](http://www.boriel.com/wiki/en/images/7/72/HobbitEl.gif)|![Knight & Demonds DX](http://www.boriel.com/wiki/en/images/f/fe/KnightsDemonsDX.png)| +|---|---|---| +| An in-game screenshot of Eleuterio by @*na_th_an* | Ingame screenshot of _El Hobbit_ by @*Wilco2000*| Ingame screenshot of _Knignt and Demonds DX_ by Einar Saukas + +See more examples at http://www.boriel.com/wiki/en/index.php/ZX_BASIC:Released_Programs + QUICK START ----------- -For a quick start, just open a terminal in your PC (Windows) and type -`zxb` or `zxb.py` (OSX, Linux). You should see a zxbasic message. +For a quick start, just open a terminal in your PC in the same directory you uncompressed ZX Basic +and type `zxb` (on Windows) or `zxb.py` (OSX, Linux). You should see a zxbasic message like this: + +``` +usage: zxb [-h] [-d] [-O OPTIMIZE] [-o OUTPUT_FILE] [-T] [-t] [-B] [-a] [-A] + [-S ORG] [-e STDERR] [--array-base ARRAY_BASE] + [--string-base STRING_BASE] [-Z] [-H HEAP_SIZE] [--debug-memory] + [--debug-array] [--strict-bool] [--enable-break] [-E] [--explicit] + [-D DEFINES] [-M MEMORY_MAP] [-i] [-I INCLUDE_PATH] [--strict] + [--version] + PROGRAM +zxb: error: the following arguments are required: PROGRAM +``` -Create a text file, `hello.bas` with the following content: +Create a text file with the following content: ~~~~ 10 CLS 20 PRINT "HELLO WORLD!" ~~~~ -and compile it with: +Save it as `hello.bas` and finally compile it with: ~~~~ zxb -taB hello.bas ~~~~ diff --git a/zxbasic_logo.png b/zxbasic_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..1064b448842e396783bc4dd35beb9e05df3de13a GIT binary patch literal 624 zcmV-$0+0QPP)IVP-0sTot zK~#9!?cGgsgD?z+;keV2^vvzqy6aWwj$sk-uLwBLyJF!8lKDpZMwUrhmgNDQ#fP5& z1czz)T(8ns$PJc1KQd%E5F7{&2=j3L#;e=~rj#mNV6Jgf6)ie!_7-P`yhB|zM}F0-cZNT$30zqIlg@l|VE?_UB9tta;h>~qUTO|PcjxEwiQfSw zCL7^JCu^Qsh&f(nQ}U299F$ZL9B_t*>pzcF+M&F2g}d#neo3YAdF15;QH+R*Oyi0!k_f z4k++&<%XcfKBb@Bir=Gf%XiZgRvH literal 0 HcmV?d00001