<commit_before>BoxMaker
========

What is BoxMaker?
-----------------

BoxMaker is a simple little application that can generate the outlines for a box to be out of some material with a cutting device (ideally using wood/acrylic on a lasercutter!).  You tell it the dimensions of the box (width, height, depth, material width), and it generates a PDF with the outlines for the six sides of the box.

The edges are notched, so it snaps together well.  You can import the PDF it creates into CorelDraw (or any other standard drawing program) and manipulate it further there (probably rearrange the pieces to fit on the shape of the material you have at hand).

How to Compile
--------------

BoxMaker is a Java program built with the Ant system.  You will need to install both before you can compile the code.  Once you have that installed, just run ant in this directory and it will create a BOX.jar with the compiled code for you.  BoxMaker makes use of the iText PDF library for PDF generation.

**Compile**

```
ant
```

**Generate API Documentation**

```
ant doc.javadoc
```

**Clean**

```
ant.clean
```

How to Use
----------

**To quickly test it, just run the `render-box.sh` script.**

You can run BoxMaker from the command line like this (all the numbers are specified in millimeteres):

```
java -cp BOX.jar com.rahulbotics.boxmaker.CommandLine [file_to_output] [width] [height] [depth] [material_thickness] [cut_width] [notch_length] [draw_bounding_box]
```

For instance, the `render-box` script does this to draw a 4" x 5" x 6" box:

```
java -cp BOX.jar com.rahulbotics.boxmaker.CommandLine test-box.pdf 101.6 127 152.4 4.7625 0 11.90625 false
```<commit_msg>fixed typo in instructions<commit_after>BoxMaker
========

What is BoxMaker?
-----------------

BoxMaker is a simple little application that can generate the outlines for a box to be out of some material with a cutting device (ideally using wood/acrylic on a lasercutter!).  You tell it the dimensions of the box (width, height, depth, material width), and it generates a PDF with the outlines for the six sides of the box.

The edges are notched, so it snaps together well.  You can import the PDF it creates into CorelDraw (or any other standard drawing program) and manipulate it further there (probably rearrange the pieces to fit on the shape of the material you have at hand).

How to Compile
--------------

BoxMaker is a Java program built with the Ant system.  You will need to install both before you can compile the code.  Once you have that installed, just run ant in this directory and it will create a BOX.jar with the compiled code for you.  BoxMaker makes use of the iText PDF library for PDF generation.

**Compile**

```
ant
```

**Generate API Documentation**

```
ant doc.javadoc
```

**Clean**

```
ant clean
```

How to Use
----------

**To quickly test it, just run the `render-box.sh` script.**

You can run BoxMaker from the command line like this (all the numbers are specified in millimeteres):

```
java -cp BOX.jar com.rahulbotics.boxmaker.CommandLine [file_to_output] [width] [height] [depth] [material_thickness] [cut_width] [notch_length] [draw_bounding_box]
```

For instance, the `render-box` script does this to draw a 4" x 5" x 6" box:

```
java -cp BOX.jar com.rahulbotics.boxmaker.CommandLine test-box.pdf 101.6 127 152.4 4.7625 0 11.90625 false
```
{'fraction_non_alphanumeric': 0.10383814340969949, 'fraction_numerical': 0.01606664683130021, 'mean_word_length': 3.748587570621469, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3886966', 'n_tokens_mistral': 1042, 'n_tokens_neox': 959, 'n_words': 492}