Renames files and adds some stuff to the README.

* `README` now has some actual information instead of being full of
  nothingness.
* Renaming according to `.b` convention as `.bf` is for Befunge which came
  earlier.
* Comments out unnecessary dependencies on shexp etc. for now.
* Adds Mandelbrot output file.
* Makes small corrections to documentation.

Author: theindigamer

.gitignore

@@ -1,9 +1,10 @@
 _build/
+b2piet.docdir
 *.byte
 *.native
 *.png
 *.ppm
 src/metaJson_*
-bf2p-meta.json
+b2piet-meta.json
 *.log
 ?piet

README.md

@@ -2,5 +2,5 @@
 <src/metaJson_*> : package(atdgen)
 <src/utils.*>: package(camlimages.all_formats), package(integers), package(atdgen)
 <src/printer.*>: package(camlimages.all_formats)
-<src/bf2piet.*>: package(cmdliner), package(camlimages.all_formats), package(atdgen), package(integers)
-<src/tests.*>: package(oUnit), package(qcheck), package(atdgen), package(integers), package(camlimages.all_formats), package(cmdliner), package(shexp.process), thread
+<src/b2piet.*>: package(cmdliner), package(camlimages.all_formats), package(atdgen), package(integers)
+<src/tests.*>: package(qcheck), package(atdgen), package(integers), package(camlimages.all_formats), package(cmdliner)

_tags

@@ -0,0 +1,83 @@
+# b2piet: A Brainfuck to Piet transpiler
+
+## What :open_mouth:
+
+## Hi :smile:
+
+Pick your favourite tagline:
+
+> Fast, correct and beautiful - pick 3.
+
+> Fucking drawings.
+
+> Ultrapostmodern polyfunctional cybergraffiti.
+
+> :arrow_forward::fu::computer::tractor::no_good::art::computer::rocket::metal:
+
+## Build :cold_sweat:
+
+### Pre-requisites
+
+#### Platforms
+
+The program has only been tested on Linux.
+Ideally, it should work on OS X as is.
+It will probably not work on Windows.
+
+#### Dependencies
+
+By default, `b2piet` will only be able to produce `.ppm` and `.bmp` images.
+For very large images, the file size will quickly become large if you use `.ppm`
+files.
+So it is strongly suggested that you install an external library to be able to
+save images as `.png` files. The appropriate dependency name can be found
+in the `camlimages`'s installation instructions [here][camlimages-install].
+
+It is currently listed as `libpng`, which you can install through your
+distribution's package manager.
+You should install the Ocaml package `camlimages` (described below) _after_
+you've installed `libpng`.
+
+You will need a working installation of Ocaml version
+`v : 4.03.0 ≤ v ≤ 4.04.2`.
+Versions outside this range may or may not work.
+Instructions for installing Ocaml can be found on [ocaml.org][ocaml].
+
+Don't forget to double-check the installed version number before proceeding
+to install packages.
+
+You should install the following dependencies using [OPAM][opam]
+(OPAM itself will be installed when you install Ocaml):
+
+* `atdgen`
+* `batteries`
+* `camlimages`
+* `cmdliner`
+* `integers`
+* `ocamlfind`
+* `ocamlbuild`
+* `qcheck` (for tests)
+* `ppx_deriving` (latest version)
+* `merlin` (optional, latest version)
+
+These can usually be installed as:
+
+```
+# Install libpng using your package manager
+opam install atdgen batteries camlimages cmdliner integers ocamlfind ocamlbuild qcheck
+opam pin add ppx_deriving --dev-repo
+opam pin add merlin --dev-repo
+```
+
+Lastly, you will need some version of `make` (e.g. `GNU make`) for ease of use.
+
+[ocaml]: http://ocaml.org/
+[opam]: https://opam.ocaml.org/
+[camlimages-install]: https://bitbucket.org/camlspotter/camlimages/src/b18e82a3d840c458f5db3f33309dd2d6e97bef91/INSTALL.rst?at=default
+
+## How :sunglasses:
+
+## Thanks :clap:
+
+Thanks to all the developers of our dependencies. Special thanks to authors of
+`cmdliner` and `qcheck` for having the best documentation :smile:.

bf2piet.odocl b2piet.odocl

@@ -11,23 +11,24 @@ metajsonml:
 	atdgen -j -j-std src/metaJson.atd
 
 bytecode: metajsonml
-	ocamlbuild -use-ocamlfind src/bf2piet.byte
+	ocamlbuild -use-ocamlfind src/b2piet.byte
 
 native: metajsonml
-	ocamlbuild -use-ocamlfind src/bf2piet.native
+	ocamlbuild -use-ocamlfind src/b2piet.native
 
 clean:
 	rm -f src/metaJson_*
 	ocamlbuild -clean
 
+# Use native version as bytecode is *much* slower
 test: metajsonml
-	ocamlbuild -use-ocamlfind src/tests.byte
-	./tests.byte
+	ocamlbuild -use-ocamlfind src/tests.native
+	./tests.native
 
 doc-default:
-	ocamlbuild -use-ocamlfind bf2piet.docdir/index.html
+	ocamlbuild -use-ocamlfind b2piet.docdir/index.html
 
 copycss:
-	cp style/style.css _build/bf2piet.docdir/
+	cp style/style.css b2piet.docdir/
 
 doc: doc-default copycss

docs/README.md

@@ -0,0 +1,48 @@
+AAAAAAAAAAAAAAAABBBBBBBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDEGFFEEEEDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAAAAABBBBBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDEEEFGIIGFFEEEDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAAABBBBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDEEEEFFFI KHGGGHGEDDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAABBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEEFFGHIMTKLZOGFEEDDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAABBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEEEFGGHHIKPPKIHGFFEEEDDDDDDDDDCCCCCCCCCCBBBBBBBBBBBBBBBBBB
+AAAAAAAAAABBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEEFFGHIJKS  X KHHGFEEEEEDDDDDDDDDCCCCCCCCCCBBBBBBBBBBBBBBBB
+AAAAAAAAABBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEEFFGQPUVOTY   ZQL[MHFEEEEEEEDDDDDDDCCCCCCCCCCCBBBBBBBBBBBBBB
+AAAAAAAABBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEFFFFFGGHJLZ         UKHGFFEEEEEEEEDDDDDCCCCCCCCCCCCBBBBBBBBBBBB
+AAAAAAABBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEFFFFFFGGGGHIKP           KHHGGFFFFEEEEEEDDDDDCCCCCCCCCCCBBBBBBBBBBB
+AAAAAAABBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDEEEEEFGGHIIHHHHHIIIJKMR        VMKJIHHHGFFFFFFGSGEDDDDCCCCCCCCCCCCBBBBBBBBB
+AAAAAABBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDEEEEEEFFGHK   MKJIJO  N R  X      YUSR PLV LHHHGGHIOJGFEDDDCCCCCCCCCCCCBBBBBBBB
+AAAAABBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDEEEEEEEEEFFFFGH O    TN S                       NKJKR LLQMNHEEDDDCCCCCCCCCCCCBBBBBBB
+AAAAABBCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDEEEEEEEEEEEEFFFFFGHHIN                                 Q     UMWGEEEDDDCCCCCCCCCCCCBBBBBB
+AAAABBCCCCCCCCCCCCCCCCCCCCCCCCCDDDDEEEEEEEEEEEEEEEFFFFFFGHIJKLOT                                     [JGFFEEEDDCCCCCCCCCCCCCBBBBB
+AAAABCCCCCCCCCCCCCCCCCCCCCCDDDDEEEEEEEEEEEEEEEEFFFFFFGGHYV RQU                                     QMJHGGFEEEDDDCCCCCCCCCCCCCBBBB
+AAABCCCCCCCCCCCCCCCCCDDDDDDDEEFJIHFFFFFFFFFFFFFFGGGGGGHIJN                                            JHHGFEEDDDDCCCCCCCCCCCCCBBB
+AAABCCCCCCCCCCCDDDDDDDDDDEEEEFFHLKHHGGGGHHMJHGGGGGGHHHIKRR                                           UQ L HFEDDDDCCCCCCCCCCCCCCBB
+AABCCCCCCCCDDDDDDDDDDDEEEEEEFFFHKQMRKNJIJLVS JJKIIIIIIJLR                                               YNHFEDDDDDCCCCCCCCCCCCCBB
+AABCCCCCDDDDDDDDDDDDEEEEEEEFFGGHIJKOU  O O   PR LLJJJKL                                                OIHFFEDDDDDCCCCCCCCCCCCCCB
+AACCCDDDDDDDDDDDDDEEEEEEEEEFGGGHIJMR              RMLMN                                                 NTFEEDDDDDDCCCCCCCCCCCCCB
+AACCDDDDDDDDDDDDEEEEEEEEEFGGGHHKONSZ                QPR                                                NJGFEEDDDDDDCCCCCCCCCCCCCC
+ABCDDDDDDDDDDDEEEEEFFFFFGIPJIIJKMQ                   VX                                                 HFFEEDDDDDDCCCCCCCCCCCCCC
+ACDDDDDDDDDDEFFFFFFFGGGGHIKZOOPPS                                                                      HGFEEEDDDDDDCCCCCCCCCCCCCC
+ADEEEEFFFGHIGGGGGGHHHHIJJLNY                                                                        TJHGFFEEEDDDDDDDCCCCCCCCCCCCC
+A                                                                                                 PLJHGGFFEEEDDDDDDDCCCCCCCCCCCCC
+ADEEEEFFFGHIGGGGGGHHHHIJJLNY                                                                        TJHGFFEEEDDDDDDDCCCCCCCCCCCCC
+ACDDDDDDDDDDEFFFFFFFGGGGHIKZOOPPS                                                                      HGFEEEDDDDDDCCCCCCCCCCCCCC
+ABCDDDDDDDDDDDEEEEEFFFFFGIPJIIJKMQ                   VX                                                 HFFEEDDDDDDCCCCCCCCCCCCCC
+AACCDDDDDDDDDDDDEEEEEEEEEFGGGHHKONSZ                QPR                                                NJGFEEDDDDDDCCCCCCCCCCCCCC
+AACCCDDDDDDDDDDDDDEEEEEEEEEFGGGHIJMR              RMLMN                                                 NTFEEDDDDDDCCCCCCCCCCCCCB
+AABCCCCCDDDDDDDDDDDDEEEEEEEFFGGHIJKOU  O O   PR LLJJJKL                                                OIHFFEDDDDDCCCCCCCCCCCCCCB
+AABCCCCCCCCDDDDDDDDDDDEEEEEEFFFHKQMRKNJIJLVS JJKIIIIIIJLR                                               YNHFEDDDDDCCCCCCCCCCCCCBB
+AAABCCCCCCCCCCCDDDDDDDDDDEEEEFFHLKHHGGGGHHMJHGGGGGGHHHIKRR                                           UQ L HFEDDDDCCCCCCCCCCCCCCBB
+AAABCCCCCCCCCCCCCCCCCDDDDDDDEEFJIHFFFFFFFFFFFFFFGGGGGGHIJN                                            JHHGFEEDDDDCCCCCCCCCCCCCBBB
+AAAABCCCCCCCCCCCCCCCCCCCCCCDDDDEEEEEEEEEEEEEEEEFFFFFFGGHYV RQU                                     QMJHGGFEEEDDDCCCCCCCCCCCCCBBBB
+AAAABBCCCCCCCCCCCCCCCCCCCCCCCCCDDDDEEEEEEEEEEEEEEEFFFFFFGHIJKLOT                                     [JGFFEEEDDCCCCCCCCCCCCCBBBBB
+AAAAABBCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDEEEEEEEEEEEEFFFFFGHHIN                                 Q     UMWGEEEDDDCCCCCCCCCCCCBBBBBB
+AAAAABBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDEEEEEEEEEFFFFGH O    TN S                       NKJKR LLQMNHEEDDDCCCCCCCCCCCCBBBBBBB
+AAAAAABBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDEEEEEEFFGHK   MKJIJO  N R  X      YUSR PLV LHHHGGHIOJGFEDDDCCCCCCCCCCCCBBBBBBBB
+AAAAAAABBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDEEEEEFGGHIIHHHHHIIIJKMR        VMKJIHHHGFFFFFFGSGEDDDDCCCCCCCCCCCCBBBBBBBBB
+AAAAAAABBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEFFFFFFGGGGHIKP           KHHGGFFFFEEEEEEDDDDDCCCCCCCCCCCBBBBBBBBBBB
+AAAAAAAABBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEFFFFFGGHJLZ         UKHGFFEEEEEEEEDDDDDCCCCCCCCCCCCBBBBBBBBBBBB
+AAAAAAAAABBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEEFFGQPUVOTY   ZQL[MHFEEEEEEEDDDDDDDCCCCCCCCCCCBBBBBBBBBBBBBB
+AAAAAAAAAABBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDDEEEEEEFFGHIJKS  X KHHGFEEEEEDDDDDDDDDCCCCCCCCCCBBBBBBBBBBBBBBBB
+AAAAAAAAAAABBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEEEFGGHHIKPPKIHGFFEEEDDDDDDDDDCCCCCCCCCCBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAABBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDDDEEEEEFFGHIMTKLZOGFEEDDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAAABBBBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDDDEEEEFFFI KHGGGHGEDDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBBBB
+AAAAAAAAAAAAAAABBBBBBBBBBBBBCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCDDDDDDDDDDEEEFGIIGFFEEEDDDDDDDDCCCCCCCCCBBBBBBBBBBBBBBBBBBBBBBBBBB

design.md docs/design.md

@@ -88,24 +88,24 @@ let info =
   let man = [
     `S   Manpage.s_examples;
     `P   "Basic usage:";
-    `Pre "    \\$ ./bf2piet.byte \"+++++++++++++++++++++++++++++++++.\"";
+    `Pre "    \\$ ./b2piet.byte \"+++++++++++++++++++++++++++++++++.\"";
     `P   "saves a Piet program to `a.png` that prints '!'.";
-    `P   "We can also use code from a `.bf` file:";
-    `Pre "    \\$ ./bf2piet.byte --input bf_samples/hello.bf --output hello.png";
+    `P   "We can also use code from a `.b` file:";
+    `Pre "    \\$ ./b2piet.byte --input samples/hello.b --output hello.png";
     `P   "The default stack size of 8 is sufficient for small programs but \
           will give incorrect results for non-trivial ones. One should try out \
           different combinations manually. In the following case, we have \
           checked that a stack size of 18 is sufficient.";
-    `Pre "    \\$ ./bf2piet.byte --stack=18 --input bf_samples/homura.bf";
+    `Pre "    \\$ ./b2piet.byte --stack=18 --input samples/homura.b";
     `S Manpage.s_bugs;
-    `P ("Please open an issue on https://github.com/theindigamer/bf-piet/ for \
+    `P ("Please open an issue on https://github.com/theindigamer/b2piet/ for \
          any bugs, or if you need help with using this software. If you do \
          not have a Github account and do not wish to create one, please send \
-         an email to `theindigamer15 AT gmail DOT com` with the bug report.");
+         me an email (see below) with the bug report.");
     `S Manpage.s_authors;
-    `P  "theindigamer"
+    `P  "Varun Gandhi <theindigamer15 AT gmail DOT com>"
   ]
-  in Term.info "bf2piet" ~doc ~exits:Term.default_exits ~man
+  in Term.info "b2piet" ~doc ~exits:Term.default_exits ~man
 
 let get_stack_size ?(use_json = true) ?(stack_auto = true)
     ?(stack_size = 8) ~str ~bfinstr meta =

ir-block.org docs/ir-block.org

@@ -58,8 +58,8 @@ let full meta str =
   Painter.(paint (Fast fpl) Linear) ir_l |> Printer.save_picture "temp.ppm" 1;
   bfout_str
 
-let pietevalstr () =
-  Shexp_process.(eval(pipe (run "./npiet" ["temp.ppm"]) read_all))
+(* let pietevalstr () = *)
+(*   Shexp_process.(eval(pipe (run "./npiet" ["temp.ppm"]) read_all)) *)
 
 let sink f x y =
   let _ = f x y in
@@ -77,11 +77,11 @@ let domains_fit_correctly_t =
             ~count:100 ~name:"Domains fit compactly."
             (make bfprog_gen) (domains_fit_correctly meta))
 
-let full_t =
-  let meta = Utils.MetaJson.get in
-  QCheck.(Test.make
-            ~count:100 ~name:"End_to_end"
-            (make bfprog_gen) (fun s -> (=) (pietevalstr ()) @@ full meta s))
+(* let full_t = *)
+(*   let meta = Utils.MetaJson.get in *)
+(*   QCheck.(Test.make *)
+(*             ~count:100 ~name:"End_to_end" *)
+(*             (make bfprog_gen) (fun s -> (=) (pietevalstr ()) @@ full meta s)) *)
 
 let _ = QCheck_runner.set_verbose true
 let _ = QCheck_runner.run_tests_main [

layout.md docs/layout.md

@@ -612,7 +612,7 @@ module MetaJson = struct
       | None -> h in
     String.fold_left go fnv_offset_basis s
 
-  let metafile = "bf2p-meta.json"
+  let metafile = "b2piet-meta.json"
 
   let filestr fname =
     if Sys.file_exists fname then