~jojo/Carth

1b50115ea459c9a844ca3522c11dcdf96f326495 — Johan Johansson 2 years ago 0d13559
Add usage examples to README
2 files changed, 33 insertions(+), 2 deletions(-)

M README.org
M TODO.org
M README.org => README.org +32 -1
@@ 11,10 11,12 @@ Purely functional programming with lisp-syntax. Less infix, more parens!
- Currying
- Compiled with LLVM-based backend

** TODO Examples

** Roadmap

This is a high-level overview of what is planned for the language, and
some of the points are just tentative. See [[TODO.org]] for more extensive
some of the points are just tentative. See [[./TODO.org][TODO.org]] for more extensive
list of planned features and more detailed descriptions.

- Algebraic datatypes


@@ 23,6 25,35 @@ list of planned features and more detailed descriptions.
- Effect system
- Linear types

** Building
   This project is written in [[https://haskell.org][Haskell]] and uses the [[https://www.haskellstack.org/][Stack]] build
   system. The external dependencies required are [[https://llvm.org/][LLVM]] version 8. To
   build the project, simply run ~stack build~. To install (copy the
   binary), run ~stack install~.

** Running
   #+BEGIN_EXAMPLE bash
# General help
carth help
carth -h
carth --help

# Help for a specific subcommand
carth help interpret
carth help c

# Interpret a file
carth i examples/test.carth

# Compile and run a program with default output filename
carth c examples/test.carth
./out

# Compile a program with a specific output filename
carth c -o examples/test.bin examples/test.carth
./examples/test.bin
   #+END_EXAMPLE

** License

   AGPLv3

M TODO.org => TODO.org +1 -1
@@ 3,7 3,7 @@
Features and other stuff to do/implement in/around Carth.

*IMPORTANT*: When done implementing a TODO, make sure to document the
changes in the [[REFERENCE.org][REFERENCE]] if applicable! Also, mark the TODO as *DONE*
changes in the [[./REFERENCE.org][REFERENCE]] if applicable! Also, mark the TODO as *DONE*
with a short note of what was done and how it went, unless the TODO
was trivial and unimportant, in which case the section can just be
removed. Please also link to the commit that does the thing if