code.kerkeslager.com Git - fur/blob - README.md

   1 # fur
   2
   3 Fur is a programming language for the next millenium. In 1000 years, humans will likely still like
   4 furry animals, so Fur is named in their honor.
   5
   6 ## Installation
   7
   8 1. Create and activate a virtual environment with Python 3. On most systems, this will look something like `python3 -m venv .env/ && .env/bin/activate`.
   9 2. Install dependencies from `requirements.txt` using `pip`: `pip install -r requirements.txt`.
  10 3. That's all!
  11
  12 ## Integration tests
  13
  14 To run the unit tests, run `python integration_tests.py`. You can test just the output of the examples or just the memory usage of the tests by running
  15 `python integration_tests.py OutputTests` or `python integration_tests.py MemoryLeakTests` respectively.
  16
  17 # Running
  18
  19 Example Fur programs are in the `examples/` folder. The main compiler (`main.py`) compiles Fur
  20 programs to C. An example of usage:
  21
  22     ~/fur$ python main.py examples/01_hello.fur
  23     ~/fur$ gcc examples/01_hello.fur.c
  24     ~/fur$ ./a.out
  25     Hello, world~/fur$
  26
  27 ## Disclaimers
  28
  29 Fur is GPL 3 and will only ever target GPL compilers. Fur supports closures, integer math, boolean
  30 logic, lists, structures (similar to objects), and strings (implemented as
  31 [ropes](https://en.wikipedia.org/wiki/Rope_(data_structure))).  It doesn't yet support
  32 exceptions, multithreading, modules, or anything resembling a standard library.  If that sounds
  33 like something you want to use in production code, good luck to you.