Documentation/cleanup

Apparently the export syntax actually does hide the rest of the stuff in
scope, as long as you load the module instead of directly loading the
file from GHCI.

Still trying to get hackage to notice that I want it to autogenerate
documentation. Maybe module-level comments will help.
This commit is contained in:
Steven Dee 2013-11-05 16:10:44 -05:00
parent 7e825a9591
commit 712ef0710f
3 changed files with 31 additions and 10 deletions

View File

@ -1,5 +1,16 @@
module Language.Nock5K (Noun(..), Nock, nock, noun, repl) where
-- | Implementation of the Nock 5K spec.
module Language.Nock5K (
-- * Structures
Noun(..),
Nock,
-- * Reduction
nock,
-- * Parser
noun,
-- * REPL
repl
) where
import Language.Nock5K.Parse (noun)
import Language.Nock5K.Repl (repl)
import Language.Nock5K.Spec (Noun(..), Nock, nock)
import Language.Nock5K.Parse
import Language.Nock5K.Repl
import Language.Nock5K.Spec

8
README
View File

@ -1,5 +1,6 @@
Usage:
./hsnock.lhs
Try: ./hsnock.lhs
Install: cabal install hsnock
Try forms like:
[42 1 0]
@ -8,6 +9,3 @@ Try forms like:
[42 [8 [1 0] 8 [1 6 [5 [0 7] 4 0 6] [0 6] 9 2 [0 2] [4 0 6] 0 7] 9 2 0 1]]
[[42 43] [8 [1 0] [8 [1 [6 [5 [0 6] [0 14]] [1 0] [6 [5 [0 6] [0 15]] [1 1] [9 2 [[0 2] [4 0 6] [0 7]]]]]] [9 2 0 1]]]]
[[43 42] [8 [1 0] [8 [1 [6 [5 [0 6] [0 14]] [1 0] [6 [5 [0 6] [0 15]] [1 1] [9 2 [[0 2] [4 0 6] [0 7]]]]]] [9 2 0 1]]]]
See also:
http://www.urbit.org/2013/08/22/Chapter-2-nock.html

View File

@ -1,11 +1,23 @@
name : hsnock
version : 0.5.0
version : 0.5.1
category : Language
license : PublicDomain
synopsis : Nock 5K interpreter.
author : Steven Dee
maintainer : mrdomino@gmail.com
homepage : https://github.com/mrdomino/hsnock/
description :
This is an implementation of the Nock 5K spec with an accompanying
interpreter.
.
Nock is a tiny stateless virtual machine that can be thought of
as a functional assembly language. Nock is the lowest layer in
the Urbit stack. On top of it rests the Hoon language, in which
the Arvo OS is written.
.
More on Urbit: <http://www.urbit.org/>
.
More on Nock: <http://www.urbit.org/2013/08/22/Chapter-2-nock.html>
build-type : Simple
cabal-version : >=1.8