README.md

   1 # XbSlicer
   2
   3 A program for slicing 3D models in STL format to GCode file.
   4
   5 Some optimizations have been implemented, check [XbSlicer paper](https://xinqibao.xyz/file/AnOptimizedSlicerFor3DPrinting.pdf) for detail.
   6
   7 Yet this software itself is not the best, but it does something. It's a personal project for practice, helped by professor Dov Kruger, from Department of Electrical & Computer Engineering at Stevens Institute of Technology.
   8
   9 ## How to run
  10
  11 run `make` to get the executable file.
  12
  13 `make MODE=release` get the release version.
  14
  15 run `xbslicer` or `xbslicer-staging` with input filename, otherwise it'll take a default file.
  16
  17 ```
  18 ./xbslicer cube.stl
  19 ```
  20
  21 Input file has to be stored in `stl_files/`, output gcode file will be in `gcode_files/`.
  22
  23 It can take STL file both in ASCII and Binary format.
  24
  25 ASCII format file with extension `.stl`, Binary format file has to be with extension `.stlb`.
  26
  27 ## TODO
  28
  29 Complicated models will require SupportMaterial to print actually stuff, XbSlicer is not support for this.
  30
  31 Still it can print some simple models with the GCode files generated by XbSlicer.
  32
  33 ## To improve
  34
  35 For now, the config file is like hard coded, every time make some change in config file, it requires to build the whole project to make it work. It is really frustrating, config file need to be read-in on running time.
  36
  37 Also, the input and output file path is not flexible, as long as file extension, especially for Binary STL file.
  38
  39 For a good command running experience, it need to have support like parser, user can pass in arguments to modify something.