Commit 69ef3b05 by kollo

update README, man-pages / html & CONTRIBUTING.md

update README update CONTRIBUTING.md
parent f1ddb5c6
......@@ -43,4 +43,39 @@ More things left to do:
- port it to apple ipad/iphone,
(etc. etc.)
## License and attribution
All contributions must be properly licensed and attributed. If you are contributing your own original work, then you are offering it under a CC-BY license (Creative Commons Attribution). If it is code, you are offering it under the GPL-v2. You are responsible for adding your own name or pseudonym in the Acknowledgments file, as attribution for your contribution.
If you are sourcing a contribution from somewhere else, it must carry a compatible license. The project was initially released under the GNU public licence GPL-v2 which means that contributions must be licensed under open licenses such as MIT, CC0, CC-BY, etc. You need to indicate the original source and original license, by including a comment above your contribution.
## Contributing with a Pull Request
The best way to contribute to this project is by making a pull request:
1. Login with your Github account or create one now
2. [Fork](https://github.com/kollokollo/X11Basic#fork-destination-box) the X11Basic repository. Work on your fork.
3. Create a new branch on which to make your change, e.g.
`git checkout -b my_code_contribution`, or make the change on the `new` branch.
4. Edit the file where you want to make a change or create a new file in the `contrib` directory if you're not sure where your contribution might fit.
5. Edit `doc/ACKNOWLEGEMENTS` and add your own name to the list of contributors under the section with the current year. Use your name, or a github ID, or a pseudonym.
6. Commit your change. Include a commit message describing the correction.
7. Submit a pull request against the X11Basic repository.
## Contributing with an Issue
If you find a mistake and you're not sure how to fix it, or you don't know how to do a pull request, then you can file an Issue. Filing an Issue will help us see the problem and fix it.
Create a [new Issue](https://github.com/kollokollo/X11Basic/issues/new) now!
## Thanks
We are very grateful for your support. With your help, this BASIC implementation will be a great project.
So you are welcome to help.
......@@ -249,9 +249,10 @@ C) The framebuffer version
D) 64bit operating systems
X11-Basic will compile on 64bit systems but it will not be 100% functional.
X11-Basic internally uses 32bit pointers (--> VARPTR()). These are not compatible
with 64bit. Some tricks have been implemented to make it work anyways, but
do not expext 100% compatibility.
X11-Basic internally uses 32bit pointers (--> VARPTR()). These are not
compatible with 64bit.
Some tricks have been implemented to make it work anyways, but do not expect
100% compatibility.
E) Crosscompiling for other platforms
......@@ -268,9 +269,6 @@ E) Crosscompiling for other platforms
make windows
d) 32bit version on 64bit system
make bit3264
For details you may want to look into the Makefile. Improvements are welcome.
......
......@@ -28,6 +28,11 @@ is the interpreter. It interpretes basic command-files (programs), which
usually have the extension .bas or .xbas.
It can also run in interactive mode in which case it interpretes single lines of
code, which are entered.
.B xbasic
can also interpret and run bytecode files, which have been compiled
before from .bas programs via the
.I xbbc(1)
bytecode compiler.
.SH COMMANDLINE OPTIONS
.P
......@@ -74,6 +79,7 @@ or press
.SH EXAMPLES
.nf
xbasic testme.bas
xbasic testme.b
xbasic -e 'alert 1,"Hello world !",1," OK ",b'
xbasic --eval 1+3-4*3
xbasic --help "*nl*"
......@@ -141,4 +147,4 @@ http://x11-basic.sourceforge.net/
/usr/share/doc/x11basic/
tcsh(1), sh(1), readline(3), xbc(1), bas211basic(1)
tcsh(1), sh(1), xbc(1), xbbc(1), bas211basic(1)
......@@ -19,8 +19,8 @@ into C sourcecode, which can be compiled with the gnu C compiler gcc or any
other ANSI C compiler, e.g. tcc, the tiny c compiler.
The sources depend on the x11basic.a or libx11basic.so libraries and on the
header file xb2csol.h, which therefore should be installed and linked. The
compiled programs will be faster that the interpreted ones and even a bit
faster that the bytecode processed ones (see
compiled programs will be faster than the interpreted ones and even a bit
faster than the bytecode processed ones (see
.I xbbc(1)
and
.I xbvm(1)
......@@ -32,7 +32,7 @@ faster that the bytecode processed ones (see
.SH Filenames
Xb2c processes one input file. The Suffix of the input file is usually .b
Xb2c processes one input file. The suffix of the input file is usually .b
(a bytecode file produced by
.I xbbc(1)
).
......
......@@ -46,7 +46,7 @@ shows version, program and other information and exits
.SS -h --help
print a short help.
For detailed help and description of the implemented basic commands take a look
For detailed help and a description of the implemented basic commands take a look
at the README file which ships with the X11-Basic package.
......
......@@ -43,17 +43,18 @@ look at the README file coming with the package and the X11-Basic manual.
.SH EXAMPLES
.nf
xbvm testme.b
xbbc -v testme.b
xbvm -v testme.b
.fi
You can find many sample programs in
.I /usr/share/doc/packages/X11Basic/examples.
.SH The virtual machine
The virtual machine is an interpreter for bytecode, which implements a stack
machine. The bytecode is very compact and similar to machine code, but still it
is independant of the actual processor hardware and such very portable. With an
additional small step it can be compiled to native assembler or machine code.
The virtual machine is an interpreter for bytecode. It implements a virtual
stack machine on which the bytecode is excecuted.
The bytecode is very compact and similar to machine code, and it
is independant of the actual processor hardware and such very portable. With an
additional small step it can be translated to native assembler or machine code.
(For linux this is done by the
.I xb2c(1)
translator and
......
......@@ -173,6 +173,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -621,6 +621,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -207,6 +207,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -237,6 +237,6 @@ details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -154,6 +154,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -84,7 +84,9 @@ document.write(ename + '@' + domain + '</a>');
<h2>Utilities</h2>
... you might also want to install:
<ul>
<li><a href="download/gfalist_0.01-1_i386.deb">gfalist_0.01-1_i386.deb</a> (22 KBytes)(deb)
<li>
<a href="download/gfalist_0.01-1_i386.deb">gfalist_0.01-1_i386.deb</a> (22 KBytes)(deb, 32 bit)
<a href="download/gfalist_0.01-1_amd64.deb">gfalist_0.01-1_amd64.deb</a> (24 KBytes)(deb, 64 bit)
-- A Program which converts *.gfa Files to ASCII ((C) 2001 by Peter Backes)
<a href="https://github.com/mmuman/gfalist" TARGET="_top">(sources)</a>
<li><a href="https://gitlab.com/kollo/X11-Basic_examples/raw/master/All/compiler/bas2x11basic.bas">bas2x11basic.bas</a> (5 KBytes)(x11basic)
......
......@@ -1015,6 +1015,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -3,7 +3,7 @@ Content-type: text/html
<HTML><HEAD><TITLE>Manpage of X11BASIC</TITLE>
</HEAD><BODY>
<H1>X11BASIC</H1>
Section: Basic Interpreter (1)<BR>Updated: 21-Dec-2015<BR><A HREF="#index">Index</A>
Section: Basic Interpreter (1)<BR>Updated: 04-Jan-2017<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
......@@ -45,6 +45,13 @@ is the interpreter. It interpretes basic command-files (programs), which
usually have the extension .bas or .xbas.
It can also run in interactive mode in which case it interpretes single lines of
code, which are entered.
<B>xbasic </B>
can also interpret and run bytecode files, which have been compiled
before from .bas programs via the
<I><A HREF="http://localhost/cgi-bin/man/man2html?1+xbbc">xbbc</A>(1) </I>
bytecode compiler.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>COMMANDLINE OPTIONS</H2>
......@@ -121,6 +128,7 @@ or press
<PRE>
xbasic testme.bas
xbasic testme.b
xbasic -e 'alert 1,&quot;Hello world !&quot;,1,&quot; OK &quot;,b'
xbasic --eval 1+3-4*3
xbasic --help &quot;*nl*&quot;
......@@ -166,7 +174,7 @@ You should be able to find one at
<A NAME="lbAS">&nbsp;</A>
<H2>VERSION</H2>
This page was created for V.1.24
This page was created for V.1.25
<A NAME="lbAT">&nbsp;</A>
<H2>BUG REPORTS</H2>
......@@ -190,7 +198,7 @@ Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sou
<A NAME="lbAV">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 1997-2016 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
Copyright (C) 1997-2017 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
<P>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
......@@ -209,7 +217,7 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
<P>
/usr/share/doc/x11basic/
<P>
<A HREF="http://localhost/cgi-bin/man/man2html?1+tcsh">tcsh</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+sh">sh</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?3+readline">readline</A>(3), <A HREF="http://localhost/cgi-bin/man/man2html?1+xbc">xbc</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+bas211basic">bas211basic</A>(1)
<A HREF="http://localhost/cgi-bin/man/man2html?1+tcsh">tcsh</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+sh">sh</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+xbc">xbc</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+xbbc">xbbc</A>(1), <A HREF="http://localhost/cgi-bin/man/man2html?1+bas211basic">bas211basic</A>(1)
<P>
<HR>
......@@ -244,6 +252,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -3,7 +3,7 @@ Content-type: text/html
<HTML><HEAD><TITLE>Manpage of XB2C</TITLE>
</HEAD><BODY>
<H1>XB2C</H1>
Section: X11-Basic to C Translator (1)<BR>Updated: 09-Apr-2015<BR><A HREF="#index">Index</A>
Section: X11-Basic to C Translator (1)<BR>Updated: 04-Jan-2017<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
......@@ -36,8 +36,8 @@ into C sourcecode, which can be compiled with the gnu C compiler gcc or any
other ANSI C compiler, e.g. tcc, the tiny c compiler.
The sources depend on the x11basic.a or libx11basic.so libraries and on the
header file xb2csol.h, which therefore should be installed and linked. The
compiled programs will be faster that the interpreted ones and even a bit
faster that the bytecode processed ones (see
compiled programs will be faster than the interpreted ones and even a bit
faster than the bytecode processed ones (see
<I><A HREF="http://localhost/cgi-bin/man/man2html?1+xbbc">xbbc</A>(1)</I>
<BR>&nbsp;and&nbsp;
......@@ -54,7 +54,7 @@ faster that the bytecode processed ones (see
<H2>Filenames</H2>
<P>
Xb2c processes one input file. The Suffix of the input file is usually .b
Xb2c processes one input file. The suffix of the input file is usually .b
(a bytecode file produced by
<I><A HREF="http://localhost/cgi-bin/man/man2html?1+xbbc">xbbc</A>(1)</I>
......@@ -140,7 +140,7 @@ Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sou
<A NAME="lbAN">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 1997-2016 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
Copyright (C) 1997-2017 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
<P>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
......@@ -181,6 +181,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -3,7 +3,7 @@ Content-type: text/html
<HTML><HEAD><TITLE>Manpage of XBBC</TITLE>
</HEAD><BODY>
<H1>XBBC</H1>
Section: X11-Basic bytecode compiler (1)<BR>Updated: 09-Aug-2015<BR><A HREF="#index">Index</A>
Section: X11-Basic bytecode compiler (1)<BR>Updated: 04-Jan-2017<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
......@@ -72,7 +72,7 @@ shows version, program and other information and exits
print a short help.
<P>
For detailed help and description of the implemented basic commands take a look
For detailed help and a description of the implemented basic commands take a look
at the README file which ships with the X11-Basic package.
<P>
<P>
......@@ -138,7 +138,7 @@ Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sou
<A NAME="lbAN">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 1997-2016 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
Copyright (C) 1997-2017 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
<P>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
......@@ -179,6 +179,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -3,7 +3,7 @@ Content-type: text/html
<HTML><HEAD><TITLE>Manpage of XBC</TITLE>
</HEAD><BODY>
<H1>XBC</H1>
Section: X11-Basic Compiler Manager (1)<BR>Updated: 21-Aug-2015<BR><A HREF="#index">Index</A>
Section: X11-Basic Compiler Manager (1)<BR>Updated: 04-Jan-2017<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
......@@ -212,7 +212,7 @@ out of a procedure).
<A NAME="lbAS">&nbsp;</A>
<H2>VERSION</H2>
Page was created for V.1.24
Page was created for V.1.25
<P>
<A NAME="lbAT">&nbsp;</A>
<H2>BUG REPORTS </H2>
......@@ -237,7 +237,7 @@ Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sou
<A NAME="lbAV">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 1997-2016 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
Copyright (C) 1997-2017 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
<P>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
......@@ -286,6 +286,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
......@@ -3,7 +3,7 @@ Content-type: text/html
<HTML><HEAD><TITLE>Manpage of XBVM</TITLE>
</HEAD><BODY>
<H1>XBVM</H1>
Section: X11-Basic Vitual Machine (1)<BR>Updated: 09-Nov-2016<BR><A HREF="#index">Index</A>
Section: X11-Basic Vitual Machine (1)<BR>Updated: 04-Jan-2017<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
......@@ -76,7 +76,7 @@ look at the README file coming with the package and the X11-Basic manual.
<PRE>
xbvm testme.b
xbbc -v testme.b
xbvm -v testme.b
</PRE>
<P>
......@@ -87,10 +87,11 @@ You can find many sample programs in
<A NAME="lbAJ">&nbsp;</A>
<H2>The virtual machine</H2>
The virtual machine is an interpreter for bytecode, which implements a stack
machine. The bytecode is very compact and similar to machine code, but still it
is independant of the actual processor hardware and such very portable. With an
additional small step it can be compiled to native assembler or machine code.
The virtual machine is an interpreter for bytecode. It implements a virtual
stack machine on which the bytecode is excecuted.
The bytecode is very compact and similar to machine code, and it
is independant of the actual processor hardware and such very portable. With an
additional small step it can be translated to native assembler or machine code.
(For linux this is done by the
<I><A HREF="http://localhost/cgi-bin/man/man2html?1+xb2c">xb2c</A>(1) </I>
......@@ -105,7 +106,7 @@ but not least, there is no way to recreate the source code from the bytecode.
<A NAME="lbAK">&nbsp;</A>
<H2>VERSION</H2>
Page was created for V.1.24
Page was created for V.1.25
<P>
<A NAME="lbAL">&nbsp;</A>
<H2>BUG REPORTS </H2>
......@@ -130,7 +131,7 @@ Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sou
<A NAME="lbAN">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright (C) 1997-2016 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
Copyright (C) 1997-2017 Markus Hoffmann &lt;<A HREF="mailto:kollo@users.sourceforge.net">kollo@users.sourceforge.net</A>&gt;
<P>
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
......@@ -171,6 +172,6 @@ PARTICULAR PURPOSE. See the GNU General Public License for more details.
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 08:51:50 GMT, April 19, 2016
Time: 11:48:24 GMT, June 18, 2017
</BODY>
</HTML>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment