Permalink
Browse files

ignore npm-debug

  • Loading branch information...
1 parent b3a1d7f commit 478b73c64bd405ba531ab105b0cfa65400c20874 @atdt committed May 24, 2012
Showing with 20 additions and 22 deletions.
  1. +20 −22 README.md
View
@@ -1,10 +1,9 @@
Snoflake
==========
-
-**Snoflake** is a JavaScript runtime for the [SNOBOL][0] (_StriNg Oriented and
-symBOlic Language_) programming language, developed between 1962 and 1967 at
-AT&T Bell Laboratories by David J. Farber, Ralph E. Griswold and Ivan P.
-Polonsky.
+**Snoflake** is a GPL-licensed JavaScript runtime for the [SNOBOL][0] (_StriNg
+Oriented and symBOlic Language_) programming language, developed between 1962
+and 1967 at AT&T Bell Laboratories by David J. Farber, Ralph E. Griswold and
+Ivan P. Polonsky.
SNOBOL is highly distinct and excels at string manipulation and
pattern-matching. SNOBOL patterns may be recursive and are available as a
@@ -20,37 +19,39 @@ moving at a rapid pace. A working implementation is expected by late summer.
Compatibility
-------------
-
**Snoflake** is designed to run in both browser and standalone environments.
The development setup requires Node.js >= 0.6. The code adheres to ES5's strict
mode.
Status
------
-
### Completed ###
* SIL parser / translator
* Data structures and memory allocation
* Execution environment
- * 85 (of 131) SIL operations
+ * 85 (of 131) SIL macros (with some tests)
+ * 100% test coverage for VM
### Todo ###
- * **Tests**
- * System stack manipulation
+ * Better test coverage of SIL macros
+ * System stack manipulation macros
+ * AJAX-powered file IO
* SNOBOL syntax tables
- * Better documentation
Contributing
------------
+The simplest way to get involved is to write a test for one of the SIL macros
+that has already been implemented. Test stubs for all SIL macros exist in
+`test/test-sil.js`, so you can pick one and add asserts.
-Documentation for contributors is forthcoming. In the meantime, if you are
-interested in contributing, [e-mail me][1].
+Additional documentation for contributors is forthcoming. In the meantime, if
+you are interested in contributing, please [e-mail me][1].
License
-------
-Copyright (C) 2012 Ori Livneh
+Copyright (C) 2012 [Ori Livneh][2]
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
@@ -59,16 +60,13 @@ version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE. See the [GNU General Public License][2] for more details.
-
-You should have received a copy of the GNU General Public License along with
-this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
-Street, Fifth Floor, Boston, MA 02110-1301, USA.
+PARTICULAR PURPOSE. See the [GNU General Public License][3] for more details.
[![Build Status][3]][4]
[0]: http://en.wikipedia.org/wiki/SNOBOL
[1]: mailto:ori.livneh@gmail.com
-[2]: http://www.gnu.org/licenses/gpl-2.0.html
-[3]: https://secure.travis-ci.org/atdt/snoflake.png?branch=master
-[4]: http://travis-ci.org/atdt/snoflake
+[2]: http://256.io/
+[3]: http://www.gnu.org/licenses/gpl-2.0.html
+[4]: https://secure.travis-ci.org/atdt/snoflake.png?branch=master
+[5]: http://travis-ci.org/atdt/snoflake

0 comments on commit 478b73c

Please sign in to comment.