Skip to content

Commit b7315ce

Browse files
authored
chore(readme): include getting started section (#12)
1 parent 5abde4f commit b7315ce

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,41 @@
11
# SharpFM
22

3-
SharpFM is a cross platform (Mac, Windows, Linux) FileMaker Pro Developer Utility to help navigate migrating FileMaker code between FileMaker files. This means you can copy scripts, layouts, tables, etc across machine barriers like Remote Desktop, Citrix/XenApp or anything that can copy plain text between machines, save them for later, change them if you want, then finally re-paste them into the same or other FileMaker file.
3+
SharpFM is a cross-platform (Mac, Windows, Linux) FileMaker Pro Developer Utility to help when migrating FileMaker code between FileMaker files, sharing FileMaker code with other developers, or simply see what's happening under the hood. This means you can copy scripts, layouts, tables, etc (anything you can copy/paste in FileMaker) across machine barriers like Remote Desktop, Citrix/XenApp or anything that can copy plain text between machines, save them for later, change them if you want, then finally re-paste them into the same or other FileMaker file.
4+
5+
## Getting Started
6+
7+
Note: SharpFM and FileMaker must be running on the same computer. In order to share or move a clip across machine barriers, you must share the text based XML version.
8+
9+
### Clipping from FileMaker
10+
11+
- Head over to [Releases](https://github.com/fuzzzerd/SharpFM/releases)
12+
- Download the latest version (or a past version if you need)
13+
- Run the application.
14+
- Switch over to FileMaker.
15+
- Copy something to the clipboard.
16+
- Switch back to SharpFM.
17+
- Use the Edit menu to "Paste from FileMaker Blob".
18+
- See your object(s) in the clips list with the Xml editor on the side.
19+
20+
### Clipping from SharmFM to FileMaker
21+
22+
- Ensure you have a clip in SharpFM
23+
- Select the clip in the list
24+
- Use the Edit menu to "Copy As FileMaker Blob"
25+
- Switch to FileMaker: based on the clip type, open Database manger, Script manager, layout mode.
26+
- Paste into FileMaker as you normally would.
27+
28+
### Saving / Sharing XML Clips
29+
30+
This is an area we can improve, with interoperability with some other similar tools. More to come? Contributions welcome.
31+
32+
SharpFM has the option to persist clips between sessions by using the File menu to "Save to Db".
33+
34+
- Save the XML for a given clip as a separate file (copy/paste to Notepad, Nano, email body, etc)
35+
- Share the resulting XML file.
36+
- Use the File menu to create a New clip.
37+
- Select the appropriate clip type (Table, Script, Layout, etc)
38+
- Paste the raw XML into the code editor.
439

540
## Features
641

@@ -10,6 +45,11 @@ SharpFM is a cross platform (Mac, Windows, Linux) FileMaker Pro Developer Utilit
1045
- [x] Persist FileMaker clips between SharpFM runs.
1146
- [ ] Better UI tools to mutate the Raw XML.
1247

48+
## Similar Mac OS / Apple Based Developer Utilities
49+
50+
- Apple Script utility: https://github.com/DanShockley/FmClipTools
51+
- FileMaker based Generator: https://github.com/proofgeist/generator
52+
1353
## App Icon
1454

1555
![Sharp FM](SharpFM.App/Assets/noun-sharp-teeth-monster-4226695.small.png)

0 commit comments

Comments
 (0)