From 3af4ea06f901bb95fba7069512b4676a32f45ff5 Mon Sep 17 00:00:00 2001 From: "Mike D. Lowis" Date: Thu, 1 Mar 2012 09:43:15 -0500 Subject: [PATCH] Updated README --- README.md | 59 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 0994ff4..e22c1d9 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,24 @@ DLang ============================================== - - Version: 0.1a - Created By: Michael D. Lowis - Email: mike@mdlowis.com + + Version: 0.1a + Created By: Michael D. Lowis + Email: mike@mdlowis.com About This Project ---------------------------------------------- -DLang is an experimental new programming language with arbitrarily extensible -syntax. The core of the language provides you the tools you need to get things +DLang is an experimental new programming language with arbitrarily extensible +syntax. The core of the language provides you the tools you need to get things done while the flexible syntax allows YOU to decide how you want to get it done. -New domain specific languages can be invented on the fly with ease to solve any +New domain specific languages can be invented on the fly with ease to solve any problem you encounter. License ---------------------------------------------- -Unless explicitly stated otherwise, all code and documentation in this project -is released under the FreeBSD License. You can find a copy of the license text +Unless explicitly stated otherwise, all code and documentation in this project +is released under the FreeBSD License. You can find a copy of the license text in the LICENSE.md file. Requirements For Building @@ -34,41 +34,42 @@ Build Instructions You build dlang with the following command: - rake release + rake release -The resulting binary is placed in 'build/bin'. You can test it with the +The resulting binary is placed in 'build/bin'. You can test it with the following commands: - build/bin/dlang example.dl - ./example.exe + build/bin/dlang example.dl + ./example.exe Installation ---------------------------------------------- -There are no installation instructions at the moment. This is a work in +There are no installation instructions at the moment. This is a work in progress. Project Files and Directories ---------------------------------------------- - build/ Output directory for artifacts created during the build. - deps/ Libraries and other dependencies the source code may have. - docs/ Documentation for the language and the source code. - res/ Submodules and files that aren't part of DLang source but it still needs - source/ The source for the DLang parser - tests/ Unit test and mock files. - tools/ Tools required by the build system. - Doxyfile Doxygen documentation generator configuration. - example.dl An example DLang source file. - LICENSE.md The software license notification. - rakefile.rb Script containing the build configuration and tasks. - README.md You're reading this file right now! + build/ Output directory for artifacts created during the build. + deps/ Libraries and other dependencies the source code may have. + docs/ Documentation for the language and the source code. + res/ Submodules and files that aren't part of DLang source but it still needs + source/ The source for the DLang parser + tests/ Unit test and mock files. + tools/ Tools required by the build system. + Doxyfile Doxygen documentation generator configuration. + example.dl An example DLang source file. + LICENSE.md The software license notification. + rakefile.rb Script containing the build configuration and tasks. + README.md You're reading this file right now! Know Issues or Bugs ---------------------------------------------- This is a non-comprehensive list of known issues and bugs that I intend to fix. +* The parser segfaults on \*nix systems due to freeing invalid pointers and other memory management issues * Leaks memory like a sieve. * Error messages are obtuse and unfriendly. * Parser and Lexer have 0 error recovery. @@ -79,14 +80,14 @@ Version History ### Version 0.1a -Very first version ever. Its buggy, has obtuse error messages, and supports +Very first version ever. Its buggy, has obtuse error messages, and supports about 1/20 of what I would like to see. Lets call it a proof of concept. Feature Wish List ---------------------------------------------- -This is a list of features are not yet supported, but may be at some point in +This is a list of features are not yet supported, but may be at some point in the future. * Command line options @@ -99,6 +100,6 @@ the future. More Info ---------------------------------------------- -For more info or general questions shoot me an email and I'll try to get back +For more info or general questions shoot me an email and I'll try to get back to you in a timely manner. -- 2.52.0