Skip to content

Commit

Permalink
extract build instructions into a file
Browse files Browse the repository at this point in the history
  • Loading branch information
Chunosov committed Oct 7, 2019
1 parent bac7e71 commit 529e4de
Show file tree
Hide file tree
Showing 3 changed files with 57 additions and 56 deletions.
58 changes: 2 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,60 +11,6 @@ Currently, version 2 is in alpha state, but it implements the most important fun
* Caustic calculation for resonators and single-pass systems.


[Here](http://rezonator.orion-project.org/index.php?page=ver2) are some details and prebuild packages for Windows, Linux.


## Prepare build environment

### Clone git repository
```bash
git clone https://github.com/orion-project/rezonator2
cd rezonator2
git submodule init
git submodule update
```
Note that submodules are in 'detached head' state by default.

### Prepare third-party libraries

#### Linux/MacOS
```bash
chmod +x ./scripts/prepare_deps.sh
./scripts/prepare_deps.sh
```

#### Windows
Windows does not provide default command line tools like `wget`, `tar` or `make`, so you have to prepare dependencies using tools you have installed following [these instructions](docs/prepare-deps-win.md).


## Build
Where it is possible, commands are the same for different OS, with some exceptions. E.g. Windows doesn't have `sudo` command, and you have to run `cmd` as Administrator instead.

### Application

#### Linux/MacOS
```bash
./scripts/build_release.sh
```
#### Windows
```bash
scripts\build_release.bat
```
Ensure that Qt bin directory is in your `PATH` to make above scripts working. On Windows, you have to put MinGW `bin` directory into the `PATH` too.

Note that above scripts do the full rebuild and it takes a while. Use *Qt Creator IDE* to do dev builds. Just open project file `rezonator.pro` in the IDE and configure it to use some of the installed Qt-kits. Any of modern Qt 5.8+ kits should suit.

### Source code documentation
```bash
sudo apt install doxygen
sudo apt install graphviz
mkdir -p out/src-doc
doxygen
```

### User manual
See [building documentation](./help/README.md).

## Run
Target file is `bin/rezonator` (Linux), `bin/rezonator.app` (MacOS), or `bin\rezonator.exe` (Windows).
See [Home page](http://rezonator.orion-project.org/index.php?page=ver2) or [Releases](https://github.com/orion-project/rezonator2/releases) for binary packages for Windows, Linux and macOS. See [build instructions](./docs/build.md) for building from source code.

![Main Window](./img/main_window.png)
55 changes: 55 additions & 0 deletions docs/build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Building from sources

## Prepare build environment

### Clone git repository
```bash
git clone https://github.com/orion-project/rezonator2
cd rezonator2
git submodule init
git submodule update
```
Note that submodules are in 'detached head' state by default.

### Prepare third-party libraries

#### Linux/MacOS
```bash
chmod +x ./scripts/prepare_deps.sh
./scripts/prepare_deps.sh
```

#### Windows
Windows does not provide default command line tools like `wget`, `tar` or `make`, so you have to prepare dependencies using tools you have installed following [these instructions](prepare-deps-win.md).


## Build
Where it is possible, commands are the same for different OS, with some exceptions. E.g. Windows doesn't have `sudo` command, and you have to run `cmd` as Administrator instead.

### Application

#### Linux/MacOS
```bash
./scripts/build_release.sh
```
#### Windows
```bash
scripts\build_release.bat
```
Ensure that Qt bin directory is in your `PATH` to make above scripts working. On Windows, you have to put MinGW `bin` directory into the `PATH` too.

Note that above scripts do the full rebuild and it takes a while. Use *Qt Creator IDE* to do dev builds. Just open project file `rezonator.pro` in the IDE and configure it to use some of the installed Qt-kits. Any of modern Qt 5.8+ kits should suit.

### Source code documentation
```bash
sudo apt install doxygen
sudo apt install graphviz
mkdir -p out/src-doc
doxygen
```

### User manual
See [building documentation](../help/README.md).

## Run
Target file is `bin/rezonator` (Linux), `bin/rezonator.app` (MacOS), or `bin\rezonator.exe` (Windows).
Binary file added img/main_window.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 529e4de

Please sign in to comment.