summaryrefslogtreecommitdiff
path: root/README.IDE.txt
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2018-12-10 16:50:56 +0100
committerAlbrecht Schlosser <albrechts.fltk@online.de>2018-12-10 16:50:56 +0100
commit745828154547e0dbd635afb9fae469eac37a255a (patch)
tree98f5264fd76dbfa1d6c513a176903e83d6f179a1 /README.IDE.txt
parent810b91471761e3d1736ed79de06b4c8a69125b30 (diff)
Rename README files to README.txt (and several similar files).
Files without '.txt' suffix can't be handled well by Windows (users), hence renaming such text files to *.txt makes FLTK more "Windows-friendly". There are a few exceptions (this is intentional): README and other files in bundled libraries (maintained upstream) are not changed.
Diffstat (limited to 'README.IDE.txt')
-rw-r--r--README.IDE.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.IDE.txt b/README.IDE.txt
new file mode 100644
index 000000000..866260536
--- /dev/null
+++ b/README.IDE.txt
@@ -0,0 +1,52 @@
+-----------------------------------------
+ HOW TO BUILD AND USE FLTK WITH AN IDE
+-----------------------------------------
+
+Since FLTK 1.4 we do no longer include IDE [1] solution files in our
+source distribution. [2]
+
+If you want to build the FLTK library with an IDE you need to use
+CMake [3] to generate the IDE files from the source distribution.
+
+The FLTK team will officially support generation of selected IDE projects,
+particularly Visual C++ and Xcode. Older version support of these IDE
+projects will be limited to the versions that are supported by and can be
+generated with CMake.
+
+Other IDE solutions generated with CMake may or may not work. The FLTK
+team will try to support as many IDE solutions as possible, but we may
+need help to adjust the CMake files to fit a particular IDE project.
+
+
+Using CMake to generate IDE project files
+------------------------------------------------------------------------
+
+IDE files can easily be created using CMake and the provided CMake files.
+
+For more informations about using CMake to build FLTK please read the file
+README.CMake.txt in the root directory of the FLTK distribution.
+
+
+ Current Status as of Nov 2016:
+-------------------------------------
+
+ Xcode: Supported Known to work.
+ Visual C++: Supported Visual C++ 2015 generator known to work.
+
+ Other IDE's: Not supported Status unknown.
+
+Note: "Not supported" doesn't mean that a particular generator does not work,
+ but the FLTK team does not put much effort into making this IDE work,
+ hence it may work for you or not. Contributions welcome.
+
+--------------------------------------------------------------------------------
+
+[1] IDE = Integrated Development Environment,
+ for instance Visual Studio, Xcode, Eclipse, ...
+ https://en.wikipedia.org/wiki/Integrated_development_environment
+
+[2] The only exception is the Android Studio IDE in ide/AndroidStudio3
+ currently provided for testing. This IDE solution is likely to be
+ moved elsewhere or removed entirely before FLTK 1.4 will be released.
+
+[3] https://cmake.org/