Skip to content

Commit

Permalink
update temp Build.md
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelcampos committed Sep 7, 2023
1 parent 50ffd5c commit 6b55392
Showing 1 changed file with 1 addition and 58 deletions.
59 changes: 1 addition & 58 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,6 @@
# How to build mGear

## Prerequisites

Git (of course)

Python 2.7

SCons

Maya 2014 ~ 2018 (*)

A C++ compiler: (*)
- gcc on linux
- clang on OSX
- Visual Studio on windows (**)

(*) Only when building the plugins

(**) The version should match the one used by the target Maya version

## Step by step process

1. Clone the repository and initialize it

```
$ git clone [email protected]:mgear-dev/mgear_dist.git
$ cd mgear_dist
$ git submodule update --init
$ git submodule foreach --recursive git checkout master
```

2. Checkout the desired branch or tag

- **develop** : latest developments
- **master** : latest official release
- **RB-x.x** : latest version in x.x series (i.e. 2.2.5 in RB-2.2)

```
$ git submodule foreach --recursive git checkout develop
$ git submodule foreach git pull origin develop
```

3. Compile

The available targets are:
- **mgear_core** : Only mgear python module.
- **mgear_solvers** : Solvers maya plugin.
- **cvwrap** : cvwrap maya plugin.
- **mgear** : everything (*default*)

```
$ scons with-maya=2017
...
(let it cook)
```

To show all available build options:

```$ scons -h```
we are using now CMAKE, this file needs to be updated.



Expand Down

0 comments on commit 6b55392

Please sign in to comment.