Skip to content

Commit

Permalink
Update the README to include Mac and Linux
Browse files Browse the repository at this point in the history
  • Loading branch information
markwal committed Apr 30, 2016
1 parent e3e35a9 commit 0077563
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 16 deletions.
2 changes: 1 addition & 1 deletion GPX
Submodule GPX updated from 06f8be to 48c32c
49 changes: 34 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

GpxUi is a graphical user interface wrapped around GPX, a command line utility.

It is Window only at the moment, but I made it with Qt with the intention of building
it for other platforms. I don't have a Mac, but I've got Linux, so if there is interest
I'll make a linux version.
Should work on Windows (test on Windows 10), Mac (tested on El Capitan) and
Linux (tested on Kubuntu 15 and 16).

GPX is a post processing utility for converting gcode output from 3D slicing
software like Cura, KISSlicer, S3DCreator and Slic3r to x3g files for standalone
Expand All @@ -16,25 +15,44 @@ settings editor and setup program to make it easy to get GPX set up and running
with the right settings. Also includes a machine settings editor so you can mess
with arcane stuff like how many steps per mm.

## Installing and running
## Installing

1. Download and run setup.exe from the [releases](https://github.com/markwalGpxUi/releases/latest) page
2. Choose your printer type
3. Choose the gcode flavor of the slicer you want to use
4. Click "Save" to save those two settings into gpx.ini
5. Click the translate button, it'll ask for the name of the gcode file and
the name of the output x3g file
### Windows

1. Download and run setup.exe from the [releases](https://github.com/markwal/GpxUi/releases/latest) page

### Mac

1. Download a GpxUi.dmg from the [releases](https://github.com/markwal/GpxUi/releases/latest) page
2. Open the GpxUi.dmg file and drag the GpxUi app to your Applications folder
3. Run GpxUi from the Launcher

### Linux

1. Build it from source (instructions below) and do `make install`
2. run "GpxUi"

## Running

1. Choose your printer type
2. Choose the gcode flavor of the slicer you want to use
3. Click "Save" to save those two settings into gpx.ini
4. Click the translate button, it'll ask for the name of the gcode file and the name of the output x3g file

## Notes

The setup added gpx.exe to your path, so you can easily add it as a post
processor to Slic3r:

1. Put Slic3r into expert mode via File.Preferences from the menu bar and
restart Slic3r
1. Put Slic3r into expert mode via File.Preferences from the menu bar and restart Slic3r
2. Choose "Print Settings" tab, "Output options" panel
3. In "Post-processing scripts" type "gpx.exe" all by itself without quotes
or parameters
3. In "Post-processing scripts" type "gpx.exe" all by itself without quotes or parameters

### Mac Note

* Replace step 3 with: In "Post-processing scripts" type "/Application/GpxUi.app/Contents/MacOS/gpx"

### Windows Notes

It added to the end of your path, so if you have a gpx.exe somewhere else on
your machine and on your path, it won't read the settings you set in GpxUi because
Expand All @@ -56,7 +74,6 @@ Help.Updates... menu.

## Future features

- As I mentioned, perhaps other platforms
- Have setup connect gpx.exe to the right-click on gcode files menu so you
can right-click on a gcode file and choose "Convert to x3g"
- A warning when it notices another gpx.exe earlier on the path
Expand All @@ -81,6 +98,7 @@ Help.Updates... menu.
4. `make` for the debug build or `make release` for the optimized build

For Windows setup.exe: `make squirrel.windows`
For Mac dmg: `make macdeployqt CODESIGNID="signature name"`

## Ubuntu build instructions

Expand All @@ -89,3 +107,4 @@ For Windows setup.exe: `make squirrel.windows`
3. Install qt5 tools and libraries `sudo apt-get install qttools5-dev-tools
qtbase5-dev`
4. `make` for the debug build or `make release` for the optimized build
5. `make install`

0 comments on commit 0077563

Please sign in to comment.