mirror of
https://github.com/gnustep/libs-gui.git
synced 2025-04-22 13:10:59 +00:00
Improvements to documentation
This commit is contained in:
parent
41d33467b0
commit
1be1140313
4 changed files with 31 additions and 5 deletions
|
@ -54,7 +54,7 @@ include $(GNUSTEP_MAKEFILES)/application.make
|
|||
|
||||
@file{common.make} and @file{application.make} are necessary to build an application, and need to be at the beginning and end respectively to the Makefile to operate properly. The @file{GNUmakefile.preamble} and @file{GNUmakefile.postamble} are optional, and permit you to define extra rules for building your application. You can include those lines without those files containing anything. Templates for those files also exist with the source code for gnustep-gui, which can simply be copied into your project and modified accordingly.
|
||||
|
||||
The table below describes the makefile variables that you can set to control the output of the make process. Note that @var{appname} refers to the application name that you set with @code{APP_NAME}. It is case sensistive and so are file names. Also, most of the variables listed below are optional if you wish to get a program to compile, but it is recommend you make use of them where appropriate. Where variables ask for flags and compiler options, they should be in the format that @command{gcc} expects, as it is the only compiler currently used with GNUstep. Many variables also take more than one parameter. They are usually separated by a space, and line breaks with a backslash. Please refer to the @cite{GNUstep Makefile Manual} for more details.
|
||||
The table below describes the makefile variables that you can set to control the output of the make process. Note that @var{appname} refers to the application name that you set with @code{APP_NAME}. It is case sensistive and so are file names. Also, most of the variables listed below are optional if you wish to get a program to compile, but it is recommend you make use of them where appropriate. Where variables ask for flags and compiler options, they should be in the format that @command{gcc} or @command{clang} expects, these the only compilers currently used with GNUstep. Many variables also take more than one parameter. They are usually separated by a space, and line breaks with a backslash. Please refer to the @cite{GNUstep Makefile Manual} for more details.
|
||||
|
||||
@cindex makefiles, components
|
||||
@table @code
|
||||
|
@ -87,7 +87,7 @@ A version number for your application.
|
|||
[Optional] This is where you list your C++ files (*.cpp, *.cc) to be compiled into your programme. It takes the same form as @code{@var{appname}_OBJC_FILES}.
|
||||
|
||||
@item @var{appname}_OBJCC_FILES
|
||||
[Optional] This is where you list your Objective-C++ files (*.mm) to be compiled into your programme. It takes the same form as the @code{@var{appname}_OBJC_FILES}.@footnote{You will need gcc 4.1 or higher to compile Objective-C++ programmes. This feature of the gcc compiler is quite new and has not been well tested.}
|
||||
[Optional] This is where you list your Objective-C++ files (*.mm) to be compiled into your programme. It takes the same form as the @code{@var{appname}_OBJC_FILES}.@footnote{You will need either clang or gcc 4.1 or higher to compile Objective-C++ programmes.}
|
||||
|
||||
@item @var{appname}_RESOURCE_FILES
|
||||
[Recommended] Here you list the @dfn{resource files} that are to be included with your application, including your application property list, interface file(s) and other images, data, etc. You can also list directories here, which should be added recursively (e.g. @file{.gorm} files are actually a directory containing three files, used to describe your interface).
|
||||
|
|
|
@ -120,11 +120,13 @@ Startup your shell and source GNUstep.sh from your GNUstep installation (if it's
|
|||
> cd ~
|
||||
> mkdir firstapp
|
||||
> cd firstapp
|
||||
> . /usr/lib/GNUstep/System/Library/Makefiles/GNUstep.sh
|
||||
> . /usr/GNUstep/System/Library/Makefiles/GNUstep.sh
|
||||
>
|
||||
@end smallexample
|
||||
|
||||
In the above, we simply created a new directory under our home directory called @file{firstapp}, changed into it and sourced our GNUstep installation (which in this case is under @file{/usr/lib}@footnote{Replace @file{/usr/lib} with the path to your GNUstep installation}).
|
||||
Your prefix could be different than this example.
|
||||
|
||||
In the above, we simply created a new directory under our home directory called @file{firstapp}, changed into it and sourced our GNUstep installation (which in this case is under @file{/usr/GNUstep}@footnote{Replace @file{/usr/GNUstep} with the path to your GNUstep installation}).
|
||||
|
||||
Next we will create our makefile. Using your favourite editor, create a file called @file{GNUmakefile} (the case is important). In this case we're using @command{vim}:
|
||||
@smallexample
|
||||
|
|
|
@ -31,7 +31,7 @@
|
|||
Interface files are often referred to as "nib" (or, more generally, model) files.@footnote{This is a throwback to the origin's of the GNUstep framework, when it's API specification (OpenStep) was based on NeXTStep, which used typedstream "nib" files (NeXT Inteface Builder) to store interfaces.} XML nib files after 10.2.x are usable by GNUstep, early nib files are ``typedstream'' style nibs which cannot be read by GNUstep. The framework can read other formats as detailed below. This section is very important to understanding key concepts in the AppKit, especially with regards to manipulation of your user interface. It is strongly recommended you do not skip this section, and refer back to it if you do not understand anything, even if you don't intend to use Gorm (also not recommended).
|
||||
|
||||
The different types of models which are usable by GNUstep are:
|
||||
@table @command
|
||||
@table @code
|
||||
@item .gorm
|
||||
.gorm files are the native format that is used by GNUstep, these are encoded and decoded in the Foundation / AppKit classes themselves. This is Gorm's native format.
|
||||
|
||||
|
|
|
@ -132,6 +132,30 @@ override standard images and color settings in GNUstep.
|
|||
Theming is extremely flexible. GNUstep can be made to blend into most environments.
|
||||
The application to modify themes is called Thematic.
|
||||
|
||||
You can set the theme using the follow command:
|
||||
|
||||
@example
|
||||
defaults write NSGlobalDomain GSTheme THEMENAME
|
||||
@end example
|
||||
|
||||
Where THEMENAME is the name of the theme installed. The locations for themes are:
|
||||
|
||||
@table @samp
|
||||
|
||||
@item PREFIX/System/Library/Themes
|
||||
System themes
|
||||
|
||||
@item PREFIX/Local/Library/Themes
|
||||
Locally installed themes
|
||||
|
||||
@item ~/GNUstep/Library/Themes
|
||||
User installed themes
|
||||
|
||||
@end table
|
||||
|
||||
Where PREFIX is whatever prefix that was specified when building GNUstep. Usually
|
||||
this is /usr/GNUstep, /usr/local/GNUstep, or /.
|
||||
|
||||
@subsection NSWorkspace
|
||||
|
||||
Here is (I think) the current state of the code (largely untested) -
|
||||
|
|
Loading…
Reference in a new issue