Skip to content

Commit

Permalink
housekeeping
Browse files Browse the repository at this point in the history
  • Loading branch information
bill-auger committed May 16, 2016
1 parent 7fe8ca5 commit 199a539
Show file tree
Hide file tree
Showing 22 changed files with 1,061 additions and 96 deletions.
81 changes: 46 additions & 35 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,43 +1,11 @@
# links
# av-caster
cppcheck-filtered
dbg
mk
mk-clean
mk-reset


# builds
Builds/*
!Builds/*/
Builds/*/*
!Builds/CodeBlocksLinux/AvCaster.cbp
!Builds/CodeBlocksWindows/AvCaster.cbp
!Builds/Makefile/Makefile
!Builds/MacOSX/AvCaster.xcodeproj
!Builds/MacOSX/Info.plist
!Builds/MacOSX/RecentFilesMenuTemplate.nib
!Builds/Packaging/_service
!Builds/Packaging/av-caster.dsc
!Builds/Packaging/av-caster.spec
!Builds/Packaging/debian.changelog
!Builds/Packaging/debian.control
!Builds/Packaging/debian.rules
!Builds/Packaging/PKGBUILD
!Builds/Packaging/README.md
!Builds/Scripts/cppcheck-filtered
!Builds/Scripts/dbg
!Builds/Scripts/mk
!Builds/Scripts/mk-clean
!Builds/Scripts/mk-reset
!Builds/Scripts/README.md
!Builds/Scripts/setup-build-helpers
!Builds/VisualStudio2008/AvCaster.sln
!Builds/VisualStudio2008/AvCaster.vcproj
!Builds/VisualStudio2008/resources.rc
!Builds/VisualStudio2015/AvCaster.sln
!Builds/VisualStudio2015/AvCaster.vcxproj
!Builds/VisualStudio2015/AvCaster.vcxproj.filters
!Builds/VisualStudio2015/resources.rc
Builds/Makefile/.gdbinit
Builds/Makefile/debug.log


# nix
Expand All @@ -58,3 +26,46 @@ Builds/*/*

# c::b
*.layout


# juce
._*
*.mode1v3
*.pbxuser
*.perspectivev3
*.user
*.ncb
*.suo
*.ilk
*.pch
*.pdb
*.dep
*.idb
*.manifest
*.manifest.res
*.o
*.d
*.sdf
*.opensdf
*.VC.db
*.VC.opendb
xcuserdata
*.xccheckout
contents.xcworkspacedata
.DS_Store
.svn
profile
**/MacOSX/build
**/iOS/build
**/Makefile/build
**/VisualStudio*/Debug
**/VisualStudio*/Release
**/VisualStudio*/x64
**/Android*/bin
**/Android*/libs
**/Android*/gen
**/Android*/obj
**/CodeBlocks*/bin
**/CodeBlocks*/obj
**/CodeBlocks*/*.depend
**/CodeBlocks*/*.layout
13 changes: 13 additions & 0 deletions Assets/ASSETS_LICENSE.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0"
src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />

The images and audio in this directory are licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
Creative Commons Attribution-ShareAlike 4.0 International License</a>

<br />except for:
<ul>
<li>config.xcf, config-btn.png, config-hover.png, config-pushed.png (wrench image)
<br />these are derrived from the [tango desktop project's](http://tango-project.org/) preferences-system.png</li>
<ul>
16 changes: 13 additions & 3 deletions Assets/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
###CREDITS:
* wrench image by the tango desktop project
http://tango.freedesktop.org/
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0"
src="https://i.creativecommons.org/l/by-sa/4.0/88x31.png" /></a><br />

The images and audio in this directory are licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
Creative Commons Attribution-ShareAlike 4.0 International License</a>

<br />except for:
<ul>
<li>config.xcf, config-btn.png, config-hover.png, config-pushed.png (wrench image)
<br />these are derrived from the [tango desktop project's](http://tango-project.org/) preferences-system.png</li>
<ul>
10 changes: 10 additions & 0 deletions Assets/av-caster.desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Desktop Entry]
Name=AvCaster
GenericName=
Comment=Desktop, webcam, and audio streaming tool
Categories=AudioVideo;Network;
Exec=av-caster
Icon=avcaster-logo-48.png
StartupNotify=true
Terminal=false
Type=Application
10 changes: 7 additions & 3 deletions Builds/Scripts/cppcheck-filtered
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,28 @@ echo "running cppcheck --enable=all on ./Source/ with filters"

# supress warnings for 'unused' event handlers
# so that we can exclude the JUCE library from cppcheck
cppcheck --enable=all --template=gcc --quiet Source/ 2> >(
cppcheck --enable=all --template=gcc --quiet -i Source/Trace Source/ 2> >(
grep -v "Cppcheck cannot find all the include files" |
grep -v "The function 'initialise' is never used." |
grep -v "The function 'anotherInstanceStarted' is never used." |
grep -v "The function 'moreThanOneInstanceAllowed' is never used." |
grep -v "The function 'userTriedToCloseWindow' is never used." |
grep -v "The function 'closeButtonPressed' is never used." |
grep -v "The function 'timerCallback' is never used." |
grep -v "The function 'getApplicationName' is never used." |
grep -v "The function 'getApplicationVersion' is never used." |
grep -v "The function 'resized' is never used." |
grep -v "The function 'paint' is never used." |
grep -v "The function 'run' is never used." |
grep -v "The function 'broughtToFront' is never used." |
grep -v "The function 'mouseDown' is never used." |
grep -v "The function 'buttonClicked' is never used." |
grep -v "The function 'comboBoxChanged' is never used." |
grep -v "The function 'sliderValueChanged' is never used." |
grep -v "The function 'textEditorFocusLost' is never used." |
grep -v "The function 'valueTreePropertyChanged' is never used." |
grep -v "The function 'run' is never used." |
grep -v "The function 'textEditorReturnKeyPressed' is never used." |
grep -v "The function 'valueTreeChildAdded' is never used." |
grep -v "The function 'valueTreeChildRemoved' is never used." )
grep -v "The function 'valueTreeChildRemoved' is never used." |
grep -v "The function 'textEditorTextChanged' is never used." |
grep -v "has a constructor with 1 argument that is not explicit." )
25 changes: 16 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
### Disclaimer

AvCaster source code and assets are distributed under the terms of the GNU Lesser General Public License version 3.
As a contributor, you agree that all unlicensed contributions to the source tree, wiki, and issue tracker will automatically fall under the same licence as AvCaster.
In short, this means that you allow others to copy, distribute, and modify their copies or your work as long as they extend this priviledge to others and credit you as the original author if they distribute.
If you are not the original sole author of your contribution (i.e. it is a derivative work incorporating or based on someone else's work) , then all source works must be freely copyable and distributable under the terms of some GPL-compatible license (such as Creative Commonns) and you must clearly give attribution to the copyright holders with a hyperlinks to the original sources.
As a contributor, you agree that all contributions to the source tree, wiki, and issue tracker that are unlicensed and not in the public domain will automatically fall under the same appropriate licence as AvCaster: ([LGPL3](LICENSE.md) for source code, [CC BY-SA 4.0](Assets/README.md)) for images and audio, and [GNU-FDL](Doc/README.md) for documentation.
In short, this means that you allow others to copy, distribute, and modify their copies or your work as long as they extend this priviledge to others and credit you as the original author.
If you are not the sole author of your contribution (i.e. it is a combined or derivative work incorporating or based on someone else's work) , then all source works must be freely copyable and distributable under the terms of some GPL-compatible license (such as Creative Commonns) and you must clearly give attribution to the copyright holders with a hyperlinks to the original sources.
Any such contributions that are under the terms of a GPL-compatible license will retain their current license.
No other contributions will be accepted.


### Developers
You will find in the Builds/Scripts directory some helper scripts to aid in building and debugging this application. Simply run ```./Builds/Scripts/setup-build-helpers``` to install them. This is not relevant to most development tasks, but if you must use the Introjucer GUI builder for design or project maintenance, please compile it from the 'gnu-jucer' branch as described in the 'Designers' section below.
You will find in the Builds/Scripts directory some helper scripts to aid in building and debugging this application with gcc and gdb.
Simply run ```./Builds/Scripts/setup-build-helpers``` to install them to the av-caster root directory. See Builds/Scripts/README.md for usage.
Generally speaking, the files under the Builds/ directory are not to be modified manually nor should any reconfiguration be done from within an IDE.
This is sometimes necessary for experimentation but note that these changes will not persist.
Inevitably, all project configuration must be done using the Projucer project manager because the important files in all of the Builds/ directories are clobbered by the Projucer on each save.
In short, it is almost always the case that files under the Builds/ directory that are committed to version control are only those generated by Projucer and otherwise unmodified.
This is not relevant to most development tasks, but if you must use the Projucer for design or project maintenance, please compile it from the 'gnu-jucer' branch as described in the 'Designers' section below.


### Designers
Expand All @@ -19,17 +25,18 @@ You will find in the Builds/Scripts directory some helper scripts to aid in buil
as noted in the README.md
then fork the AvCaster repo, clone the design branch,
and compile as noted in the README.md
then clone and compile the Introjucer GUI builder and project manager ###
then clone and compile the Projucer GUI builder and project manager ###
### Clone the design branch locally ###
$ cd YOUR_DEV_DIR
$ git clone -b design https://github.com/YOUR_GITHUB_NICK/av-caster
### then compile AvCaster as noted in the README.md ###

### Compile the Introjucer GUI builder and project manager ###
### Compile the Projucer GUI builder and project manager ###
$ cd YOUR_DEV_DIR
$ git clone -b gnu-jucer --depth 1 https://github.com/bill-auger/JUCE.git juce
$ cd juce/extras/Introjucer/Builds/Linux/
$ cd juce/extras/Projucer/Builds/LinuxMakefile/
$ make
$ ./build/Introjucer
### then select "Open" from the Introjucer "File" menu and browse to the AvCaster.jucer file in this project root directory. ###
$ ./build/Projucer ../../../../../av-caster/AvCaster.jucer
```


Expand Down
Loading

0 comments on commit 199a539

Please sign in to comment.