diff --git a/README.md b/README.md index a9f41b8..46c4938 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,47 @@ smooth connected paths are made out of an extremely restrictive grid, like multi ## dependencies -* [vpype](https://github.com/abey79/vpype), for converting to HPGL, [Installation instructions](https://github.com/abey79/vpype#installation) +* python +* flask +* figlet +* svgbob +* [optional] [vpype](https://github.com/abey79/vpype), for converting to HPGL + +## installation + +Firstly [download](https://gitlab.constantvzw.org/osp/tools.cobbled-paths/-/archive/master/tools.cobbled-paths-master.zip) this repository, or clone it: `git clone git@gitlab.constantvzw.org:osp/tools.cobbled-paths.git` + +### Python + +The interface uses python and require python 3, find information on how to [install python here](https://www.python.org/downloads/) + +Then, use pip to install the requirements with: + +```pip install -r requirements.txt``` + +### Figlet + +On **linux**, install it with package manager: `apt install figlet`, or `pacman -S figlet` + +On **Mac**, you can either download a pre-built binary from the [figlet website](http://www.figlet.org/), or install it with [Homebrew](https://brew.sh/): `brew install figlet`. + + +### To install SVG Bob + +Ensure you have rust installed, [installation instructions here](https://www.rust-lang.org/tools/install) + +Then `cargo install svgbob_cli` + +### vpype + +Installation of vpype is optional. It is used to convert the SVG files to HPGL. + +Please follow the [installation instructions](https://github.com/abey79/vpype#installation) ## font database * figlet offical ftp at - * `ours` the original default font made by the developper and given with the program, in early 1993 + * `ours` the original default font made by the developer and given with the program, in early 1993 * `contributed` fonts made by figlet amateur and submitted to the official figlet ftp, from before 1993 to 2005 * `c64` are fonts that are only made of the `#` character, the most black ascii char, is if it was a pixel * `bdffont` are fonts automatically made using bdf2figlet, converting [Glyph Bitmap Distribution Format](https://en.wikipedia.org/wiki/Glyph_Bitmap_Distribution_Format), often from adobe to `c64` like font. diff --git a/requirements.txt b/requirements.txt index 0021545..0eb56cd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,2 @@ Flask -pyinkscape requests \ No newline at end of file