mirror of
https://github.com/fltk/fltk.git
synced 2026-05-21 14:31:40 +08:00
Update README's and some documentation
Documentation updates are not complete, but I updated most of the http: links to https: and most references to subversion or svn to git.
This commit is contained in:
Albrecht Schlosser
+13
-10
@@ -10,31 +10,34 @@ FLTK 1.3.5 and previous versions contain many improvements and bug fixes.
|
||||
|
||||
Even though FLTK 1.3.5 does not fix all STRs, we decided to release
|
||||
FLTK 1.3.5 as it contains many new features, bug fixes, and adaptations
|
||||
to new compiler releases and OS versions (e.g. macOS 10.13 "High Sierra"
|
||||
to new compiler releases and OS versions (e.g. macOS 10.14 "Mojave"
|
||||
and better configure support for some Linux platforms).
|
||||
|
||||
Open bugs and feature requests can be viewed (offline) in KNOWN_BUGS.html
|
||||
with your browser. Links in this file direct you to the current state
|
||||
(online) of all listed bugs and feature requests.
|
||||
|
||||
Note: This file is a snapshot of http://www.fltk.org/roadmap.php at the
|
||||
date of this release (Nov. 11, 2016). Please take into account that some
|
||||
Note: This file is a snapshot of https://www.fltk.org/roadmap.php
|
||||
as of this release (Feb. 2019). Please take into account that some
|
||||
bugs and/or feature requests in this list might have been fixed without
|
||||
notice.
|
||||
|
||||
Bugs and feature requests for FLTK 1.4.x may also apply to FLTK 1.3.5.
|
||||
|
||||
FLTK 1.3.5 is expected to be the last release in the 1.3.x series.
|
||||
|
||||
All currently open STR's for 1.3.x will be fixed in FLTK 1.4.x, if possible.
|
||||
All bug reports for 1.3.x will be fixed in FLTK 1.4.x if possible.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Note to svn (subversion) users: This branch (branch-1.3) is end of life
|
||||
since the release of FLTK 1.3.4. Only very serious bug fixes will be
|
||||
available if FLTK 1.4.0 is not yet released or not (yet) stable enough.
|
||||
Note to Git users: This branch (branch-1.3) is end of life since the
|
||||
release of FLTK 1.3.4. Only very serious bug fixes will be available
|
||||
if FLTK 1.4.0 is not yet released or not (yet) stable enough.
|
||||
|
||||
This release (1.3.5) is a bug fix and maintenance release without new
|
||||
FLTK features.
|
||||
FLTK features (except macOS Mojave support).
|
||||
|
||||
The current development branch is branch-1.4 -- please checkout a new,
|
||||
clean working copy if you want to get branch-1.4.
|
||||
The current development branch is 'master' -- please checkout a new,
|
||||
clean working copy if you want to get FLTK 1.4 (master).
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
@@ -23,12 +23,11 @@ LICENSING
|
||||
|
||||
ON-LINE DOCUMENTATION
|
||||
|
||||
All of the documentation is in HTML in the subdirectory
|
||||
"documentation". The "index.html" file should be your
|
||||
starting point. PostScript(tm) and PDF versions of this
|
||||
documentation is also available from the FLTK web site at:
|
||||
Documentation is available online in HTML form and can be
|
||||
downloaded as separate distribution tarballs. A PDF version of
|
||||
this documentation is also available from the FLTK web site at:
|
||||
|
||||
http://www.fltk.org/documentation.php
|
||||
https://www.fltk.org/documentation.php
|
||||
|
||||
|
||||
BUILDING AND INSTALLING FLTK UNDER UNIX AND Mac OS X
|
||||
@@ -85,16 +84,16 @@ BUILDING AND INSTALLING FLTK UNDER UNIX AND Mac OS X
|
||||
need to run "make install-desktop" as root.
|
||||
|
||||
|
||||
SVN USERS
|
||||
|
||||
If you've just checked out a fresh copy of FLTK from SVN,
|
||||
GIT USERS
|
||||
|
||||
If you've just checked out a fresh copy of FLTK from Git (GitHub),
|
||||
you'll need to generate an initial version of 'configure'
|
||||
by running 'make makeinclude'. (We don't include a copy
|
||||
of configure in svn)
|
||||
of configure in git.)
|
||||
|
||||
|
||||
MAKE TARGETS
|
||||
|
||||
|
||||
make -- builds the library + test programs (does not install)
|
||||
make install -- builds and installs
|
||||
make clean -- clean for a rebuild
|
||||
@@ -124,7 +123,7 @@ BUILDING HTML DOCUMENTATION
|
||||
If you want to build the PDF documentation:
|
||||
|
||||
( cd documentation && make pdf )
|
||||
|
||||
|
||||
FLTK uses doxygen for documentation, so you'll at least need doxygen
|
||||
installed for creating html docs, and LaTeX for creating PDF docs.
|
||||
|
||||
@@ -133,22 +132,23 @@ INTERNET RESOURCES
|
||||
|
||||
FLTK is available on the 'net in a bunch of locations:
|
||||
|
||||
- WWW: http://www.fltk.org/
|
||||
http://www.fltk.org/str.php [for reporting bugs]
|
||||
http://www.fltk.org/software.php [source code]
|
||||
- WWW: https://www.fltk.org/
|
||||
https://www.fltk.org/str.php [for reporting bugs]
|
||||
https://www.fltk.org/software.php [source code]
|
||||
|
||||
To join the FLTK mailing list, go the following web page:
|
||||
|
||||
http://www.fltk.org/newsgroups.php
|
||||
https://www.fltk.org/newsgroups.php
|
||||
|
||||
REPORTING BUGS
|
||||
|
||||
To report a bug in FLTK, use the form at:
|
||||
|
||||
http://www.fltk.org/str.php
|
||||
https://www.fltk.org/str.php
|
||||
|
||||
For general support and questions, please use the FLTK
|
||||
mailing list at "fltk@fltk.org".
|
||||
For general support and questions, go the following web page:
|
||||
|
||||
https://www.fltk.org/newsgroups.php
|
||||
|
||||
|
||||
TRADEMARKS
|
||||
@@ -162,12 +162,12 @@ TRADEMARKS
|
||||
|
||||
COPYRIGHT
|
||||
|
||||
FLTK is copyright 1998-2017 by Bill Spitzak and others,
|
||||
FLTK is copyright 1998-2019 by Bill Spitzak and others,
|
||||
see the CREDITS file for more info.
|
||||
|
||||
This library is free software. Distribution and use rights are
|
||||
outlined in the file "COPYING" which should have been included with
|
||||
this file. If this file is missing or damaged, see the license at:
|
||||
|
||||
http://www.fltk.org/COPYING.php
|
||||
https://www.fltk.org/COPYING.php
|
||||
|
||||
|
||||
+15
-15
@@ -72,8 +72,8 @@ This chapter of this document gives a brief overview of
|
||||
compiling and using FLTK with the Cygwin and MinGW compiler
|
||||
toolkits. Both toolkits provide a build environment based
|
||||
around the GNU C/C++ compiler. Further information is
|
||||
available from the FLTK website at http://www.fltk.org, such
|
||||
as this Howto note: http://www.fltk.org/articles.php?L598
|
||||
available from the FLTK website at https://www.fltk.org, such
|
||||
as this Howto note: https://www.fltk.org/articles.php?L598
|
||||
|
||||
The Cygwin build environment supplies a library (the Cygwin
|
||||
DLL) that is primarily intended to provide a number of
|
||||
@@ -193,15 +193,15 @@ the Start menu.
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
into your home folder. The default location as seen from MSWindows is similar
|
||||
to
|
||||
|
||||
C:\MinGW\msys\1.0\home\matt\
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of
|
||||
that page. Unpack FLTK into a convenient location. I like to have everything
|
||||
in my dev directory:
|
||||
|
||||
@@ -215,7 +215,7 @@ in my dev directory:
|
||||
Configuring FLTK
|
||||
------------------
|
||||
|
||||
If you got FLTK via subversion then you need one extra step. Otherwise skip
|
||||
If you got FLTK via git then you need one extra step. Otherwise skip
|
||||
over this part. Stay in your FLTK source-code directory and type the
|
||||
following:
|
||||
|
||||
@@ -244,7 +244,7 @@ linking:
|
||||
|
||||
Known Problems:
|
||||
|
||||
There is a known incompatibility with some Windows subversion tools that
|
||||
There is a known incompatibility with some Windows git tools that
|
||||
may not set the correct line endings for autoconf. If you get strange
|
||||
error messages when running ./configure or make, you may need to convert
|
||||
configh.in to "Unix line endings" (LF-only). These error messages are
|
||||
@@ -257,7 +257,7 @@ Known Problems:
|
||||
or with your favorite editor, if it allows to change the line endings,
|
||||
then run autoconf and ./configure again.
|
||||
For further information see this bug report:
|
||||
http://www.fltk.org/newsgroups.php?gfltk.bugs+v:10197
|
||||
https://www.fltk.org/newsgroups.php?gfltk.bugs+v:10197
|
||||
|
||||
|
||||
Building FLTK
|
||||
@@ -330,10 +330,10 @@ or building FLTK on a multicore CPU will be very painful!
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of
|
||||
that page.
|
||||
|
||||
Unpack FLTK by using an appropriate unpacker and copy the new folder into a
|
||||
@@ -451,10 +451,10 @@ Express edition is free of charge and sufficient to develop FLTK applications:
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of
|
||||
that page.
|
||||
|
||||
Unpack FLTK by using an appropriate unpacker and copy the new folder into a
|
||||
@@ -618,7 +618,7 @@ The following links may be of use:
|
||||
|
||||
3. Check out the FLTK newsgroups at the FLTK homepage:
|
||||
|
||||
http://www.fltk.org/
|
||||
https://www.fltk.org/
|
||||
|
||||
Its archival search facilities are EXTREMELY useful
|
||||
to check back through previous problems with this
|
||||
|
||||
+15
-15
@@ -1,5 +1,5 @@
|
||||
README.OSX.txt - 2016-04-01 - Building FLTK under Apple OS X
|
||||
------------------------------------------------------------
|
||||
README.OSX.txt - 2019-01-06 - Building FLTK under macOS
|
||||
-------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
@@ -73,10 +73,10 @@ to keep the Terminal in the Dock.
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of that
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of that
|
||||
page. Unpack FLTK into a convenient location. I like to have everything in my
|
||||
dev directory:
|
||||
|
||||
@@ -87,14 +87,14 @@ dev directory:
|
||||
tar xvfz fltk-1.3.xxxx.tar.gz
|
||||
cd fltk-1.3.xxxx
|
||||
|
||||
If you got FLTK via subversion then you need one extra step: build the
|
||||
If you got FLTK via git then you need one extra step: build the
|
||||
configure script. Otherwise skip the following part marked ADVANCED:
|
||||
|
||||
ADVANCED: (only if you got FLTK via subversion)
|
||||
ADVANCED: (only if you got FLTK via git)
|
||||
- The preferred procedure is to build the configure script using tools
|
||||
called autoconf and automake. If these tools are not both available
|
||||
on your system, this post
|
||||
http://www.fltk.org/newsgroups.php?s15486+gfltk.coredev+v15499
|
||||
https://www.fltk.org/newsgroups.php?s15486+gfltk.coredev+v15499
|
||||
details how to get them.
|
||||
|
||||
Then, stay in your FLTK source-code directory and type the following:
|
||||
@@ -102,7 +102,7 @@ ADVANCED: (only if you got FLTK via subversion)
|
||||
NOCONFIGURE=1 ./autogen.sh
|
||||
|
||||
- Alternatively, copy the configure script from the last FLTK weekly snapshot
|
||||
to your svn source-code directory.
|
||||
to your git source-code directory.
|
||||
|
||||
:END_ADVANCED
|
||||
|
||||
@@ -209,10 +209,10 @@ FLTK USING XCODE4'
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of that
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of that
|
||||
page. You can use the SCM system that is built into Xcode.
|
||||
|
||||
Unpack FLTK by double-clicking it and copy the new folder into a convenient
|
||||
@@ -366,10 +366,10 @@ the Download section in the Preferences dialog.
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of that
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of that
|
||||
page. You can use the SCM system that is built into Xcode.
|
||||
|
||||
Unpack FLTK by double-clicking it and copy the new folder into a convenient
|
||||
|
||||
+35
-29
@@ -67,7 +67,7 @@ Open a shell and install some software:
|
||||
|
||||
sudo apt-get install g++
|
||||
sudo apt-get install gdb
|
||||
sudo apt-get install subversion
|
||||
sudo apt-get install git
|
||||
sudo apt-get install autoconf
|
||||
sudo apt-get install libx11-dev
|
||||
sudo apt-get install libglu1-mesa-dev
|
||||
@@ -81,13 +81,15 @@ If you are planning to use the Code::Blocks IDE, also install this
|
||||
|
||||
sudo apt-get install codeblocks
|
||||
|
||||
I like to use subversion to install the latest FLTK-1.3.release:
|
||||
I like to use git to install the latest FLTK-1.3.release:
|
||||
|
||||
git clone https://github.com/fltk/fltk fltk-1.3
|
||||
cd fltk-1.3
|
||||
git checkout branch-1.3
|
||||
|
||||
svn co http://seriss.com/public/fltk/fltk/branches/branch-1.3/ fltk-1.3
|
||||
|
||||
To update to the latest version, just go into the fltk-1.3 directory and type
|
||||
|
||||
svn update
|
||||
git pull
|
||||
|
||||
|
||||
2.2 Linux Mint 9
|
||||
@@ -103,7 +105,7 @@ Open a shell and install some software:
|
||||
|
||||
sudo apt-get install g++
|
||||
sudo apt-get install gdb
|
||||
sudo apt-get install subversion
|
||||
sudo apt-get install git
|
||||
sudo apt-get install autoconf
|
||||
sudo apt-get install libx11-dev
|
||||
sudo apt-get install libglu1-mesa-dev
|
||||
@@ -117,15 +119,15 @@ If you are planning to use the Code::Blocks IDE, also install this
|
||||
|
||||
sudo apt-get install codeblocks
|
||||
|
||||
I like to use subversion to install the latest FLTK-1.3.release:
|
||||
I like to use git to install the latest FLTK-1.3.release:
|
||||
|
||||
git clone https://github.com/fltk/fltk fltk-1.3
|
||||
cd fltk-1.3
|
||||
git checkout branch-1.3
|
||||
|
||||
svn co http://seriss.com/public/fltk/fltk/branches/branch-1.3/ fltk-1.3
|
||||
|
||||
To update to the latest version, just go into the fltk-1.3 directory and type
|
||||
|
||||
svn update
|
||||
|
||||
FIXME: no FL_SYMBOL font (-*-symbol-*), font 15 (Zapf-Dingbats)
|
||||
git pull
|
||||
|
||||
|
||||
2.3 Fedora 13
|
||||
@@ -153,15 +155,15 @@ Don't forget to leave root status (Ctrl-D) before loading FLTK. To install FLTK
|
||||
for every user, you either have to set root user again, or use "visudo" to add
|
||||
yourself to the "sudo" list.
|
||||
|
||||
I like to use subversion to install the latest FLTK-1.3.release:
|
||||
I like to use git to install the latest FLTK-1.3.release:
|
||||
|
||||
git clone https://github.com/fltk/fltk fltk-1.3
|
||||
cd fltk-1.3
|
||||
git checkout branch-1.3
|
||||
|
||||
svn co http://seriss.com/public/fltk/fltk/branches/branch-1.3/ fltk-1.3
|
||||
|
||||
To update to the latest version, just go into the fltk-1.3 directory and type
|
||||
|
||||
svn update
|
||||
|
||||
FIXME: no FL_SYMBOL font (-*-symbol-*), font 15 (Zapf-Dingbats)
|
||||
git pull
|
||||
|
||||
|
||||
2.8 SunOS / Solaris
|
||||
@@ -242,18 +244,20 @@ To use the current stable version of FLTK, simply install it from pkgsrc:
|
||||
cd /usr/pkgsrc/x11/fltk13
|
||||
bmake install
|
||||
|
||||
For the latest development snapshot, first install the svn client from pkgsrc:
|
||||
For the latest development snapshot, first install the git client from pkgsrc:
|
||||
|
||||
cd /usr/pkgsrc/devel/subversion
|
||||
cd /usr/pkgsrc/devel/git
|
||||
bmake install
|
||||
|
||||
Now fetch the latest FLTK source code:
|
||||
|
||||
svn co http://seriss.com/public/fltk/fltk/branches/branch-1.3/ fltk-1.3
|
||||
git clone https://github.com/fltk/fltk fltk-1.3
|
||||
cd fltk-1.3
|
||||
git checkout branch-1.3
|
||||
|
||||
To update to the latest version, just go into the fltk-1.3 directory and type
|
||||
|
||||
svn update
|
||||
git pull
|
||||
|
||||
If you have installed JPEG and PNG libraries from pkgsrc, configure your
|
||||
environment as follows so that the FLTK configure script can find them:
|
||||
@@ -276,10 +280,10 @@ To install GNU autoconf from pkgsrc:
|
||||
|
||||
Download FLTK from here:
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
If you are familiar with "subversion" and like to stay current with your
|
||||
version, you will find the subversion access parameters at the bottom of that
|
||||
If you are familiar with "git" and like to stay current with your
|
||||
version, you will find the git access parameters at the bottom of that
|
||||
page. Unpack FLTK into a convenient location. I like to have everything in my
|
||||
dev directory:
|
||||
|
||||
@@ -294,7 +298,7 @@ dev directory:
|
||||
3.2 Configuring FLTK
|
||||
-----------------------
|
||||
|
||||
If you got FLTK via subversion then you need one extra step. Otherwise skip
|
||||
If you got FLTK via git then you need one extra step. Otherwise skip
|
||||
over this part. Stay in your FLTK source-code directory and type the
|
||||
following:
|
||||
|
||||
@@ -325,8 +329,10 @@ The entire FLTK toolkit including many test programs will be built for you. No
|
||||
warnings should appear. If some do, please let the FLTK developer team know via
|
||||
the mailing list or the bug reporting template at www.fltk.org .
|
||||
|
||||
Actually, as of Apr 13 2016, one or two warnings will show, mostly about
|
||||
deprecated declarations. Please ignore them.
|
||||
Actually, as of Jan. 2019, one or two warnings will show, mostly about
|
||||
deprecated declarations. Please ignore them. If you see more warnings
|
||||
(depending on the compiler you are using) please consider upgrading to
|
||||
FLTK 1.4.
|
||||
|
||||
|
||||
3.4 Testing FLTK
|
||||
@@ -376,7 +382,7 @@ recommend that you add it to the command search path.
|
||||
===========================================
|
||||
|
||||
Code::Blocks is a free and popular C++ IDE in the Linux world. It also runs on
|
||||
OS X and MSWindows. Configured correctly, it can also cross-compile between
|
||||
macOS and Windows. Configured correctly, it can also cross-compile between
|
||||
these platforms. This chapter focuses on creating a new FLTK project for Linux,
|
||||
assuming that FLTK 1.3 was previously built and installed in its default
|
||||
location from the command line.
|
||||
|
||||
@@ -28,7 +28,7 @@ Documentation Download:
|
||||
-----------------------
|
||||
To download pre-generated docs, go to
|
||||
|
||||
http://www.fltk.org/software.php
|
||||
https://www.fltk.org/software.php
|
||||
|
||||
and look for the files
|
||||
|
||||
|
||||
@@ -356,7 +356,7 @@ FLTK is available on the 'net in a bunch of locations:
|
||||
\par WWW
|
||||
http://www.fltk.org/ <br>
|
||||
http://www.fltk.org/str.php [for reporting bugs] <br>
|
||||
http://www.fltk.org/software.php [source code]<br>
|
||||
https://www.fltk.org/software.php [source code]<br>
|
||||
http://www.fltk.org/newsgroups.php [newsgroup/forums]
|
||||
|
||||
\par NNTP Newsgroups
|
||||
|
||||
Reference in New Issue
Block a user