Skip to content

Commit

Permalink
Update setup chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiashienzsch committed May 3, 2020
1 parent 35b6d9f commit ca93378
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 16 deletions.
1 change: 1 addition & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ github.com
juce-framework
juce6
juce-6-demo
gitbook
- chapters/ci.md
TLDR
- chapters/testing/pluginval.md
Expand Down
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Projucer vs. CMake](chapters/setup/projucer_vs_cmake.md)
- [Create Project](chapters/setup/create_project.md)
- [Debugging](chapters/setup/debugging.md)
- [Documentation](chapters/setup/documentation.md)
- [Working with JUCE](chapters/working_with_juce.md)
- [User Interface](chapters/working_with_juce/user_interface.md)
- [DSP](chapters/working_with_juce/dsp.md)
Expand Down
33 changes: 17 additions & 16 deletions chapters/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,27 @@

## Project Types

- ConsoleApp
- GuiApp
- AudioApp
- Plug-in
- [Official JUCE: Choosing the right Projucer template for your application ](https://docs.juce.com/master/tutorial_choosing_projucer_template.html)

## Project Management

- git submodules
- living at head
If you have multiple projects on your machine that use JUCE, you get to a problem where you update to a new release and now you have to check all of your projects if they still compile & work. Using git submodules solves this problem. You essentially have a copy of JUCE for each of your projects and the exact version is saved in your git history. Know updating to new JUCE version can be done on a per project basis.

## Documentation
```sh
cd $PROJECT_ROOT
mkdir 3rd_party
git submodule add https://github.com/juce-framework/JUCE 3rd_party/JUCE

- comments
- GitHub Pages
- Doxygen
- readthedocs
# optional
cd 3rd_party/JUCE
git checkout juce6
```

## Check-List
### Projucer

- clang-format
- Warnings
- Optimizations
- clang-tidy
- Update module paths to new location
- Make sure it's done for each exporter

### CMake

- Update path in `add_subdirectory`
13 changes: 13 additions & 0 deletions chapters/setup/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Documentation

## Doxygen

- [Example: tobanteAudio/modEQ](https://tobanteaudio.github.io/modEQ/)

## GitHub Pages

### static files

### readthedocs

### gitbook

0 comments on commit ca93378

Please sign in to comment.