diff options
| author | Gauthier Fleutot Östervall <gauthier@ostervall.se> | 2021-07-06 02:59:13 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-06 02:59:13 +0300 |
| commit | 8f278fc65a922c6de47f62a95f17630bcec11071 (patch) | |
| tree | b5e4807bfc6e2d07c1061ab3f2de6b29b9252764 | |
| parent | 9d3361e145c806a2ea0d3c7f1f6fc7252e4d0ef1 (diff) | |
Add build instructions (#68)
Add Build Instructions and remove old Makefile.
Co-authored-by: Gauthier Östervall <gauthier.ostervall@lumenradio.com>
| -rw-r--r-- | Makefile | 17 | ||||
| -rw-r--r-- | readme.md | 13 |
2 files changed, 13 insertions, 17 deletions
diff --git a/Makefile b/Makefile deleted file mode 100644 index 47ca31c..0000000 --- a/Makefile +++ /dev/null @@ -1,17 +0,0 @@ -all: - $(MAKE) -C GcodeProcessorLib all - $(MAKE) -C ArcWelder all - $(MAKE) -C ArcWelderConsole all - $(MAKE) -C ArcWelderInverseProcessor all - -clean: - $(MAKE) -C GcodeProcessorLib clean - $(MAKE) -C ArcWelder clean - $(MAKE) -C ArcWelderConsole clean - $(MAKE) -C ArcWelderInverseProcessor clean - - -cleanall: clean - - -.PHONY: all clean @@ -13,6 +13,19 @@ The archive will contain two folders: * **bin** - Here you will find the two console applications: ArcWelder and ArcStraightener. Just copy these to your local machine and you can run them from the command line, from a script, or directly within most slicers. See the sections below for instructions on how to use these applications. * **lib** - This folder contains pre-compiled ArcWelder libraries that can be integrated into applications. The GcodeProcessorLib library has functions for parsing gcode, tracking the printer's state and position, as well as several other goodies. The ArcWelder library (requires GcodeProcessorLib) contains the core welding algorithm. +# Building from source + +From the repository root, create a build directory, generate makefile, and build: + +``` +mkdir build +cd build +cmake .. +make +``` + +The resulting console application is located in `build/ArcWelderConsole/`. You might want to create the build directory out of the repository, or make `git` ignore it, to avoid a dirty tree. + # Arc Welder Console Application This is a multiplatform console application that can be used to run the Arc Welder algorithm from a command prompt. Binaries are available for Windows, Linux, Raspbian, and MacOs. See the [installation][#installation] section for information on how to download the console application. |