Commit Graph

701 Commits

Author SHA1 Message Date
cadihowley
81cb95b514 DOCS: changes location of templates 2020-11-30 17:41:26 -05:00
cadihowley
be131fdde6 DOCS: updates landing page with other platforms 2020-11-30 17:41:26 -05:00
cadihowley
c1f6c2f638 DOCS: excludes 'contribute' folder from build 2020-11-30 17:41:26 -05:00
cadihowley
547201b294 DOCS: changes title of install page 2020-11-30 17:41:26 -05:00
cadihowley
e20ec44f80 DOCS: adds config file ref 2020-11-30 17:41:26 -05:00
cadihowley
d42a2241be DOCS: adds ref to new game files page 2020-11-30 17:41:26 -05:00
cadihowley
028a11c2d0 DOCS: tidies up FAQ 2020-11-30 17:41:26 -05:00
cadihowley
6c20b03eb1 DOCS: refines templates - settings/platform pages 2020-11-30 17:41:26 -05:00
cadihowley
b80d05563f DOCS: adds missing cmd line/config file keys 2020-11-30 17:41:26 -05:00
cadihowley
9804f4e23b DOCS: changes layout of site
- rearranges pages into "User Manual" and "Other platforms" sections
- refines "Other platforms" pages - clearer headings/structure
- updates graphics page + adds borders to images
- rewritten iOS build instructions for clarity
2020-11-30 17:41:26 -05:00
cadihowley
7d39826b26 DOCS: multiple changes in response to review
Getting started/ports:
- As a trial, redesigned the site layout
- All install/control/path info is now contained in section "The basics"
- Duplicate information  has not been removed - awaiting feedback

General changes:
- Lightened up the tone in some sections
- Made headings more descriptive
- Added reference to .ini keys on Settings pages
- Reformatted Launcher page
- Split adding/playing games into two pages
- Added favicon
- Changed formatting of inline code
2020-11-30 17:41:26 -05:00
cadihowley
9b50c278a6 DOCS: changes PDF output 2020-11-30 17:41:26 -05:00
cadihowley
e123f389fa DOCS: fixes PDF font spelling 2020-11-30 17:41:26 -05:00
cadihowley
73a6cc4306 DOCS: changes PDF fonts 2020-11-30 17:41:26 -05:00
cadihowley
23853634a6 DOCS: changes PDF output font 2020-11-30 17:41:26 -05:00
cadihowley
c50acc2014 DOCS: changes pdf output fonts 2020-11-30 17:41:26 -05:00
cadihowley
4206bc5035 DOCS: changes logo and theming
- adds ScummVM logo
- adds external link icons
- changes navbar colors
- changes PDF output - removes blank pages
- new font
2020-11-30 17:41:26 -05:00
cadihowley
2b9bcd6d7a DOCS: final drafts all pages 2020-11-30 17:41:26 -05:00
cadihowley
6d553eb5f9 DOCS: final drafts
- final drafts Quickstart, Use, Settings, and Advanced topics sections
- renames some files/folders and updates links
2020-11-30 17:41:26 -05:00
cadihowley
fb3f2dad63 DOCS: change Getting Started to Get Started. 2020-11-30 17:41:26 -05:00
cadihowley
fd6af89663 DOCS: fixes link 2020-11-30 17:41:26 -05:00
cadihowley
711fa2422f DOCS: removes double up info from bug reporting 2020-11-30 17:41:26 -05:00
cadihowley
446ffbf0e2 DOCS: style edits to multiple pages
- aligns docs with style guide
2020-11-30 17:41:26 -05:00
cadihowley
62598c8951 DOCS: final draft getting started section 2020-11-30 17:41:26 -05:00
cadihowley
055d40b56b DOCS: adds Atari/FreeMiNT page 2020-11-30 17:41:26 -05:00
cadihowley
7f0ca4d2c3 DOCS: rearranges the project
- moves android/ios back to getting started section
- moves other platforms further down sidebar navigation
- renames advanced options to advanced topics
- moves cloud/lan pages into using scummvm section
- changes index page to be only a landing page; some info moved out
- updates refs/links for new structure
2020-11-30 17:41:26 -05:00
cadihowley
9eb5c0f67c DOCS: adds port page template 2020-11-30 17:41:26 -05:00
cadihowley
3ca78637b8 DOCS: fixes ref on config file page 2020-11-30 17:41:26 -05:00
cadihowley
5751f88892 DOCS: edits Settings pages
- edits for consistency with style guide
2020-11-30 17:41:26 -05:00
cadihowley
d7caec5046 DOCS: renames section 2020-11-30 17:41:26 -05:00
cadihowley
1ca6f66d3a DOCS: final draft How to use ScummVM pages
- edits for consistency + adherence to style guide
- edits for clarity
-  removes some notes regarding game saves, now avail all engines v2.2.0
2020-11-30 17:41:26 -05:00
cadihowley
4cdcdd4181 DOCS: updates settings on 3DS page 2020-11-30 17:41:26 -05:00
cadihowley
78d536b4e5 DOCS: adds first draft RISC OS page 2020-11-30 17:41:26 -05:00
cadihowley
f2472bad5f DOCS: second draft AmigaOS 2020-11-30 17:41:26 -05:00
cadihowley
3311fc8097 DOCS: second draft 3DS page 2020-11-30 17:41:26 -05:00
cadihowley
00d41e07e6 DOCS: rearranges doc structure
- new sections: phones and tablets, consoles, other platforms
2020-11-30 17:41:26 -05:00
cadihowley
7a8790f052 DOCS: tidies up config file page
- fixes table width issues
- changes heading hierarchy for readability
2020-11-30 17:41:26 -05:00
cadihowley
b4f3bc8b86 DOCS: tidies up platform pages
- edits for consistency
2020-11-30 17:41:26 -05:00
cadihowley
4dd6ea3599 DOCS: adds gatekeeper info to mac install section 2020-11-30 17:41:26 -05:00
cadihowley
ec4a3c3e94 DOCS: removes CLI info from add/play games page 2020-11-30 17:41:26 -05:00
cadihowley
d8e94dd896 DOCS: adds first drafts 3DS/AmigaOS pages 2020-11-30 17:41:26 -05:00
cadihowley
1a7b9d9214 DOCS: updates/corrects Dreamcast page 2020-11-30 17:41:26 -05:00
cadihowley
e3054a1892 DOCS: tidies up CLI page
- fixes table width issue
- adds macOS example
- fixes tabs
- edits option descriptions for consistency
2020-11-30 17:41:26 -05:00
cadihowley
3dd5521a16 DOCS: adds custom css to change table display 2020-11-30 17:41:26 -05:00
cadihowley
183d7b325f DOCS: adds tech writer guidelines page 2020-11-30 17:41:26 -05:00
cadihowley
ad5916343e DOCS: changes Mac OSX to macOS/Mac OSX 2020-11-30 17:41:26 -05:00
cadihowley
b9311bd517 DOCS: adds first draft Dreamcast page 2020-11-30 17:41:26 -05:00
cadihowley
add423b30d DOCS: tidies up the FAQ
- adds TOC
- adds a few questions to highlight features
- tidies up formatting of answers
2020-11-30 17:41:26 -05:00
cadihowley
6f33248e1a DOCS: removes width directive from tables
- temporary fix for issue with RTD build
2020-11-30 17:41:26 -05:00
cadihowley
271b760fdc DOCS: removes width directive
- attempts to fix build issue on RTD
2020-11-30 17:41:26 -05:00
cadihowley
d7a473becb DOCS: fixes tables PS Vita 2020-11-30 17:41:26 -05:00
cadihowley
4b4f8300ea DOCS: fixes table width issues
- sets tables to take up 100% of screen width
2020-11-30 17:41:26 -05:00
cadihowley
9b0c757e39 DOCS: tidies up PSP/Vita/switch pages
- adds icons for square/circle/triagle/cross buttons
- rearranges control mapping to be more logical
-aligns button names with official hardware names
2020-11-30 17:41:26 -05:00
cadihowley
acb3b18fdf DOCS: adds sphinx-panels extension
- fixes table word-wrapping by adding custom css
- adds the ability to use bootstrap elements in the output
- trials a card-based front page
2020-11-30 17:41:26 -05:00
Lothar Serra Mari
cae1d2c277 NEWS: Update German NEWS file 2020-11-30 19:21:44 +01:00
Bartosz Gentkowski
be39e3b4d2 DOXYGEN: Doxy work on files from 'image'
There is only one file in this folder that is in scope of
GSoD - image_decoder.h. It was in great shape docwise though,
so not much review required.

The rest of the headers have received a doxy group definition.
2020-11-29 23:04:01 +00:00
Lothar Serra Mari
11afea7745 NEWS: Update German NEWS file 2020-11-29 09:37:35 +01:00
Lothar Serra Mari
730aae2562 NEWS: Update German NEWS file 2020-11-28 11:03:46 +01:00
Lothar Serra Mari
7dbdcf3bf0 NEWS: Update German NEWS file 2020-11-22 20:44:35 +01:00
Lothar Serra Mari
8b34d5ded3 NEWS: Update German NEWS file 2020-11-22 18:19:25 +01:00
Lothar Serra Mari
6c0a355209 NEWS: Update German NEWS file 2020-11-16 19:21:00 +01:00
Lothar Serra Mari
6593a1740e NEWS: Mention SCI fan translations in German NEWS file 2020-11-08 21:37:06 +01:00
Lothar Serra Mari
783b23173f NEWS: Remove obsolete NEWS entry for Russian KYRA2 2020-11-08 21:05:28 +01:00
Lothar Serra Mari
dd431ab911 NEWS: Remove mention of KYRA1 russian fan translation 2020-11-08 21:02:18 +01:00
Bartosz Gentkowski
24e3b6096e DOXYGEN: Doxygen improvements part 3
Editing doxygen comments in files:

- debug.h
- dialogs.h
- encoding.h
- endian.h
- error.h
- events.h
- fft.h
- file.h
- frac.h
- fs.h
- gui_options.h
- hash-ptr.h
- hashmap.h
- huffman.h
- ini-file.h

Plus some small changes in the config file.
2020-11-04 19:42:34 +00:00
cadihowley
2aebeb795b DOCS: renames files for consistency
- renames files and titles to conform with style guide
- fixes resulting broken links
2020-11-02 05:17:49 -05:00
cadihowley
767d6a921e DOCS: adds Guides section
- removes extra info from settings pages into standalone guides
2020-11-02 05:17:49 -05:00
cadihowley
8d9da4a677 DOCS: keeps index page up to date with all changes 2020-11-02 05:17:49 -05:00
cadihowley
f5746a7734 DOCS: second draft - Using ScummVM pages 2020-11-02 05:17:49 -05:00
cadihowley
969bab50cc DOCS: adds first draft Settings pages 2020-11-02 05:17:49 -05:00
cadihowley
f0ce76521d DOCS: adds Release notes section 2020-11-02 05:17:49 -05:00
cadihowley
da3a3c0d11 DOCS: adds first draft Other platforms pages 2020-11-02 05:17:49 -05:00
cadihowley
601baf679a DOCS: adds first draft Help section pages 2020-11-02 05:17:49 -05:00
cadihowley
b31eb824d9 DOCS: updates all screenshots for V2.2.0 2020-11-02 05:17:49 -05:00
cadihowley
3a79ee2cc3 DOCS: changes Getting started section
- removed iOS/Android pages
- Getting started will only cover Mac/Windows/Linux
2020-11-02 05:17:49 -05:00
cadihowley
b68c04b805 DOCS: adds first draft Games section pages 2020-11-02 05:17:49 -05:00
cadihowley
6f8797784f DOCS: adds second draft - Advanced Options pages 2020-11-02 05:17:49 -05:00
Matthew Duggan
5135f1f4b9 ALL: Run optipng to reduce png file size 2020-11-01 21:34:03 +09:00
Lothar Serra Mari
8929cfbcd1 NEWS: Update German NEWS file 2020-10-31 12:12:57 +01:00
Lothar Serra Mari
d625da4dcb NEWS: Update German NEWS file 2020-10-31 10:32:01 +01:00
Lothar Serra Mari
d6c67ca324 NEWS: Mention HADESCH in German NEWS file 2020-10-24 19:53:07 +02:00
Lothar Serra Mari
0eac2023db NEWS: Update German NEWS file 2020-10-24 11:05:16 +02:00
Lothar Serra Mari
d7a13e5831 NEWS: Update German NEWS file 2020-10-19 19:01:59 +02:00
Lothar Serra Mari
5118c76ce0 NEWS: Mention update to Munt 2.4.1 2020-10-17 18:17:18 +02:00
Lothar Serra Mari
b02ebc6ca7 NEWS: Fix typo in German NEWS file 2020-10-17 12:46:28 +02:00
Lothar Serra Mari
ee7abe78f4 NEWS: Update German NEWS file 2020-10-17 10:30:19 +02:00
Lothar Serra Mari
5ca3d9beee NEWS: Update German NEWS file 2020-10-10 13:01:02 +02:00
Lothar Serra Mari
546c87fac7 NEWS: Update German NEWS file 2020-10-07 18:51:33 +02:00
Thierry Crozat
fe32ac1423 DOC: Add make rule and bash script to run doxygen
The output directory is not defined by the DOXYGEN_OUTPUT_DIRECTORY
environment variable instead of being hardcoded to `html`. Both the
make rule and the bash script set that variable to `html` by default,
but in the case of the bash script we can override it by defining
the variable in the environement before running the script.
2020-10-05 02:12:48 +01:00
Bartosz Gentkowski
63da4eacb4 DOXYGEN: Add doxygen build files
This commit adds the doxygen build framework to the main
scummvm repo.
This allows to easily build and test API doc when making any
kind of changes in doxygen blocks in header files.

The build can be run from command line in the 'doxygen'
folder with 'doxygen scummvm.doxyfile'.

Output is produced in the 'html' folder and can be viewed
by opening the 'index.html' file.

The 'buildfiles' folder contains files related to style.

The output uses the vanila doxygen skin.
2020-10-05 01:58:24 +01:00
cadihowley
39988d5762 DOCS: updates index page links 2020-10-04 18:29:01 +02:00
cadihowley
df0b88a77b DOCS: corrects ref to keyboard shortcut 2020-10-04 18:29:01 +02:00
cadihowley
7a9cfd67f8 DOCS: adds reference to graphics page 2020-10-04 18:29:01 +02:00
cadihowley
5e6f9ca851 DOCS: reformats keyboard shortcuts into tables 2020-10-04 18:29:01 +02:00
cadihowley
35d980d2cd DOCS: removes outdated pages 2020-10-04 18:29:01 +02:00
cadihowley
842f5a47d4 DOCS: adds aspect ratio screenshots 2020-10-04 18:29:01 +02:00
cadihowley
78e7577fb1 DOCS: adds requirement for RTD to enable tabs 2020-10-04 18:29:01 +02:00
cadihowley
c73f20cfcd DOCS: first draft graphics page 2020-10-04 18:29:01 +02:00
cadihowley
1ac9044f4c DOCS: adds screenshots for graphics page 2020-10-04 18:29:01 +02:00
cadihowley
286e918d24 DOCS: adds tabs extension 2020-10-04 18:29:01 +02:00
cadihowley
d64ed59aeb DOCS: adds refs for some settings 2020-10-04 18:29:01 +02:00
cadihowley
1fb5055bb1 DOCS: replaced with .rst file 2020-10-04 18:29:01 +02:00
cadihowley
c54a4431d9 DOCS: adds config file paths + readability edits 2020-10-04 18:29:01 +02:00
cadihowley
dde4138985 DOCS: reformats CLI options into table 2020-10-04 18:29:01 +02:00
cadihowley
8a117e2874 DOCS: reformats keywords into table 2020-10-04 18:29:01 +02:00
cadihowley
5e60adb139 DOCS: adds refs to config keywords 2020-10-04 18:29:01 +02:00
cadihowley
563c2354c7 DOCS: corrects audio settings descriptions 2020-10-04 18:29:01 +02:00
cadihowley
07be4ff7be DOCS: corrects audio settings descriptions 2020-10-04 18:29:01 +02:00
cadihowley
ed6e16f3f3 DOCS: updates links to screenshots 2020-10-04 18:29:01 +02:00
cadihowley
cc31d41ee7 DOCS: adds/updates game/global settings 2020-10-04 18:29:01 +02:00
cadihowley
863faf0364 DOCS: updates screenshots 2020-10-04 18:29:01 +02:00
cadihowley
985aa07c15 DOCS: moves adding_games to using_scummvm section 2020-10-04 18:29:01 +02:00
cadihowley
9b27296ed3 DOCS: adds cloud info to android page 2020-10-04 18:29:01 +02:00
cadihowley
bc48829f1a DOCS: updates screenshots 2020-10-04 18:29:01 +02:00
cadihowley
3074636e03 DOCS: adds info about cloud functionality 2020-10-04 18:29:01 +02:00
cadihowley
57156ac604 DOCS: First draft for Android page 2020-10-04 18:29:01 +02:00
cadihowley
dce5303263 DOCS: adds first draft to iOS quickstart page 2020-10-04 18:29:01 +02:00
cadihowley
9c2404c0b3 DOCS: Initial commit of doc portal drafts 2020-10-04 18:29:01 +02:00
Lothar Serra Mari
67e88c1f8a NEWS: Update German NEWS file with latest Tinsel additions 2020-10-04 10:20:33 +02:00
Lothar Serra Mari
8dba7629f1 NEWS: Update German NEWS file 2020-09-20 15:18:44 +02:00
Lothar Serra Mari
d2ca714a0a NEWS: Mention latest Duckman fixes in German NEWS file 2020-09-13 22:55:20 +02:00
Lothar Serra Mari
9afb253925 NEWS: Set release date for 2.2.0 on German NEWS file 2020-09-13 22:55:15 +02:00
Lothar Serra Mari
ce0aa91746 NEWS: WIN32: Windows Vista and older is considered as deprecated 2020-09-13 19:41:51 +02:00
Lothar Serra Mari
a28d15f6eb NEWS: Discord RPC is officially supported only on Vista+
Windows XP is not supported by the Discord RPC. Technically, ScummVM
still runs with discord-rpc enabled, but it lead to random crashes.

Despite that, Discord itself is not supporting Windows XP.
2020-09-13 19:29:08 +02:00
Lothar Serra Mari
01a73777d0 NEWS: Update German NEWS file for 2.2.0 2020-09-13 12:45:55 +02:00
Lothar Serra Mari
141c9aad88 NEWS: Update German NEWS file for 2.2.0 2020-09-13 11:33:25 +02:00
Lothar Serra Mari
90b8f41bf6 NEWS: Update German NEWS file 2020-09-11 20:04:17 +02:00
Lothar Serra Mari
b50368a1d8 NEWS: Mention Discord integration on supported platforms 2020-09-11 09:30:42 +02:00
Lothar Serra Mari
e50c9c70cc NEWS: Update German NEWS file 2020-09-07 15:49:10 +02:00
Thierry Crozat
a36c20c884 README: Fix spelling of iconspath config key 2020-09-06 01:07:50 +01:00
Lothar Serra Mari
4517524ac4 NEWS: Update German NEWS file 2020-09-04 09:55:01 +02:00
Lothar Serra Mari
476aa60c9a NEWS: Mention Spanish sword2 demo in German NEWS file 2020-09-02 15:12:41 +02:00
Lothar Serra Mari
faae0ed37f NEWS: Fix missing newline in German NEWS file 2020-09-02 15:11:27 +02:00
Lothar Serra Mari
dd9256502a NEWS: Update German news file 2020-09-02 10:55:57 +02:00
Lothar Serra Mari
dda4589772 NEWS: Update German news file 2020-09-02 10:50:32 +02:00
Lothar Serra Mari
b98af03dd4 NEWS: Update German NEWS file for 2.2.0 2020-08-30 18:23:10 +02:00
Lothar Serra Mari
13aa6a37c4 NEWS: Update German NEWS file 2020-08-23 21:40:17 +02:00
Lothar Serra Mari
5831c5b4b9 NEWS: Update German NEWS file with latest improvements 2020-08-22 22:06:44 +02:00
Eugene Sandulenko
aa563f0c81 ALL: Remove PS2 port 2020-08-01 15:15:49 +02:00
Eugene Sandulenko
432383a667 ALL: Remove Tizen port 2020-08-01 14:42:45 +02:00
Lothar Serra Mari
b151733156 NEWS: Mention KYRA fixes in German NEWS file 2020-07-31 21:53:16 +02:00
Lothar Serra Mari
3529680bd8 NEWS: Fix formatting in German NEWS file 2020-07-31 21:52:08 +02:00
Lothar Serra Mari
d90af9cb2f NEWS: Mention update to munt 2.4.0 2020-07-31 21:50:31 +02:00
Lothar Serra Mari
197e1a97cf NEWS: Update German NEWS file 2020-07-31 21:30:10 +02:00
Lothar Serra Mari
a0e584b908 NEWS: Update German NEWS file 2020-07-24 21:29:15 +02:00
Lothar Serra Mari
990df13f5f NEWS: Update German NEWS file 2020-06-21 09:58:55 +02:00
Lothar Serra Mari
356026552b NEWS: Update German NEWS file 2020-06-02 22:07:28 +02:00
Lothar Serra Mari
cb6fdb5acc NEWS: Update German NEWS file 2020-05-30 08:27:02 +02:00
Lothar Serra Mari
9001e83c7e NEWS: Update German NEWS file 2020-05-30 08:27:02 +02:00
Lothar Serra Mari
40e306e45b NEWS: Update German NEWS file 2020-05-27 21:00:38 +02:00