Full documentation for FreeBASIC
http://www.freebasic.net
FreeBASIC is a free, 32-bit BASIC compiler for Windows (32-bit), protected-mode MS-DOS, and Linux (x86). It began as an attempt to create a code-compatible, free alternative to Microsoft QuickBASIC, but has quickly grown into a powerful development tool, already including support for libraries such as Allegro, SDL, OpenGL, and many others with its default installation. Aside from these, it supports the majority of legacy BASIC commands using an included runtime library, as well as an extended version of the standard QBASIC graphics functions -- all written for modern 32-bit Operating Systems.
The only reason the developers of FreeBASIC haven't made a full-scale public release of this great tool is a lack of quality documentation for the language. Former Qbasic developers -- yes, they exist, and they're even more stubborn than you think -- have been using these tools for months to create programs for Linux and Windows.
A full-featured, cross-platform compatible BASIC compiler for Windows and Linux would be useful for the same reason QuickBASIC was so prolific in the days of MS-DOS -- The design of BASIC is accessible for non-technical users and allows specialists in non-programming fields to create simple programs without understanding the underlying OS. Combined with fbIDE, the Open Source Integrated Development Environment, complete, quality documentation could bring the same accessibility to modern operating systems.
I propose to write a full, useful manual for FreeBASIC, written in a style non-programmers can understand.
It would include:
A full "Getting started" guide to step complete non-programmers into using variables, arrays, loops, operators, user-defined and intrinsic data-types, pointers, and other functions, such as string manipulation features
A full explanation and illustration of syntax
A full command reference, with a simple example for every relevant function (FreeBASIC includes over 250 functions in the rtlib)
A conservative breakdown of the time required to complete each of the above:
Full Command Reference: (250 functions * roughly 1 hour per function) = 250 hours
Full "Getting Started" guides (10 topics * roughly 2 hours per topic) = 20 hours
Full Explanation and illustration of syntax = roughly 10 hours to cover every feature
Proofreading = roughly 10 hours
Therefore, it wouldn't be unreasonable to assume that 290 hours of work on my part would be required to complete this project, which breaks down to roughly 41 work-days at 7 hours per day.
Working 7 hours daily every workday, a reasonable estimated date for completion of this project would be Wednesday August 10, 2005.
About me:
I've done technical writing in a similar format before, running qbxl magazine, an irreverent magazine dedicated to FreeBASIC. It's been well-received, and I have about 250 readers every issue. In my first term here at Red River, I took a technical writing course. I've also taken an English for Technology course at Algonquin College in Ottawa, Canada.
In terms of programming, I am familiar with C, which is important for reading the RTLIB source code to write documentation for each function. I'm also quite familiar with FreeBASIC, having been a BETA tester for early versions under the pseudonym "SJ Zero". I have created several programs of varying complexity in FreeBASIC, from the simplistic Star Phalanx to the deceivingly complex Quest for a King. I've also done considerable work on a FreeBASIC version of the djrpg Role Playing Game Development Kit (http://djrpg.sourceforge.net), which I've been slowly porting from it's native MS-DOS.
Comments (0)
You don't have permission to comment on this page.