Skip to content

Commit 6a48a3a

Browse files
authored
Merge pull request #161 from ianhi/building
add mac+linux build instructions
2 parents 41f1f37 + aee2ce9 commit 6a48a3a

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,23 @@ The windows project uses the following properties which may be overridden in the
2323
To see the default values of each property please view `MMCommon.props`
2424

2525
### Building on Mac and Linux
26-
*TODO*
2726

28-
Most users should clone the `micro-manager` repository and use this repo as a submodule.
27+
The easiest way to build on Mac or Linux is to clone the [micro-manager](https://github.com/micro-manager/micro-manager) repository and use this repo as a submodule.
28+
29+
30+
Then follow the [instructions](https://github.com/micro-manager/micro-manager/blob/main/doc/how-to-build.md#building-on-unix) for building micro-manager which will also build this repo.
31+
32+
You can avoid building the micro-manager parts and only build MMCore and the device adapters by using the following configure command: `./configure --without-java`.
33+
34+
The other thing to note is that `make install` may require the use of `sudo` unless you used the `--prefix=` option for configure.
35+
36+
#### Using your own fork
37+
If you want to make changes to this repo then you need to update the submodule to point to your fork. After you set that up you can work in the submodule as if it were a standalone git repository.
38+
39+
From the top level of the `micro-manager` folder
40+
```bash
41+
git clone git@github.com:micro-manager/micro-manager.git
42+
cd micro-manager
43+
git submodule set-url mmCoreAndDevices <git url of your fork>
44+
git submodule update --init --recursive
45+
```

0 commit comments

Comments
 (0)