Open
Conversation
ryanaltair
approved these changes
Feb 14, 2017
tgfrerer
reviewed
Feb 14, 2017
| `docs` has some documentation, things to consider for each plattform, etc. You should take a look in there; if you are on OSX, read the osx.md. Projects go into `apps` and `examples` -- `examples` contains a projects that show you how to use OF, and `apps` is where your projects go. `libs` contains the OF libraries, including the openframeworks core. `addons` aim at additional functionality that's not part of core. `export` is for DLLs and dylibs that need to be put in each project. The `scripts` folder has the tools for automating OF per platform. `project generator` is a GUI based tool for making new projects - this folder is only included in packaged releases. | ||
|
|
||
| One idea that's important is that OF releases are designed to be self-contained. You can put them anywhere on your hard drive, but it's not possible to mix different releases of OF together, so please keep each release (0.8.0, 0.8.1) separate. Projects may generally work from release to release, but this is not guaranteed. Because OF is self-contained, there's extensive use of local file paths (ie, ../../../) thoughout OF. It's important to be aware of how directories are structured. A common error is to take a project and move it so that it's a level below or above where it used to be compared to the root of OF. This means that links such as ../../../libs will break. | ||
| OF releases are designed to be self-contained. You can place them anywhere. Tt's not possible to mix different releases of OF together, so keep each release (0.8.0, 0.8.1) separate. Projects work from release to release, but this is not guaranteed. Because OF is self-contained, there's extensive use of local file paths (ie, ../../../) thoughout OF. It's important how directories are structured. A common error is to take a project and move it. This means that links such as ../../../libs will break. |
| [openFrameworks](http://openframeworks.cc/) | ||
| ================ | ||
|
|
||
| openFrameworks is a C++ toolkit for creative coding. If you are new to OF, welcome! |
Member
There was a problem hiding this comment.
Although the proposed change is more terse, it also changes the tone of voice. some might prefer a more conversational tone of voice.
|
|
||
| [http://forum.openframeworks.cc/](http://forum.openframeworks.cc/) | ||
|
|
||
| is a warm and friendly place. Please ask or answer a question. The most important part of this project is that it's a community, more than just a tool, so please join us! Also, this is free software, and we learn so much about what is hard, what doesn't make sense, what is useful, etc. The most basic questions are acceptable here! Don't worry, just join the conversation. Learning in OF is social, it's hard to do it alone, but together we can get far! |
Member
There was a problem hiding this comment.
proposed change affects tone of voice - its nicer to say please, and underlines the argument that OF is a warm and friendly place =)
|
|
||
| [https://github.com/openframeworks/openFrameworks](https://github.com/openframeworks/openFrameworks) | ||
|
|
||
| if you have bugs or feature requests, consider opening an issue. If you are a developer and want to help, pull requests are warmly welcome. Please read the contributing guide for guidelines: |
Member
There was a problem hiding this comment.
proposed change changes tone of voice to be more assertive, i'd be inclined to advocate keeping it as it is.
| 2. This GitHub repository contains code and libs for all the platforms; releases are done on a per-platform basis. | ||
| 3. This GitHub repository has no project files for the different examples. They are generated automatically for each release using a tool in `apps/projectGenerator/`. | ||
| 4. There's no external dependencies in this repository, you can download them using the download_libs.sh script for each platform in the particular platform folder inside scripts. | ||
| 4. There's no external dependencies in the repository, you can download them using the download_libs.sh script for each platform in the particular platform folder inside scripts. |
Member
There was a problem hiding this comment.
Perhaps use plural, "there are no external dependencies"
| folder structure | ||
| -------- | ||
|
|
||
| This release of OF comes with several folders: |
Member
There was a problem hiding this comment.
intent of this sentence is, i believe, to explain what the folders mean. i feel repeating the subject ("folders") to clarify is sometimes good.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.