Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme text cleanup #21

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Readme text cleanup #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3141771
Change: Shorten max line length of readmes to 76
Wuzzy2 Apr 2, 2021
9273820
Fix: Outdated help references in readme
Wuzzy2 Apr 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 29 additions & 14 deletions docs/changelog.ptxt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ OpenMSX 0.3.1
-------------
Change: Add copyright information to build system

Fix #1210: Typo in readme.
Fix #1202: Replace 'Keep on rolling' (temporarily) with 'Big Man Boogie' by Jim Redfarn
Fix #1078: Let songs set their assumed defaults (editing by Xrufu)
Fix: Typo in readme.
Fix: Replace 'Keep on rolling' with 'Big Man Boogie'
by Jim Redfarn
Fix: Let songs set their assumed defaults (editing by Xrufu)



Expand All @@ -30,16 +31,21 @@ Feature: 'Slow and Easy' by Jim Redfarn
Feature: 'City Blues' by Jim Redfarn
Feature: 'No Work Song' by Jim Redfarn
Feature: 'The Hobo' by Jim Redfarn
Feature: [Makefile] Add 'addcheck' which checks for dependencies not added to the mercurial repo
Feature: [Makefile] Introduce target 'distclean' which should delete everything not found in the tarball (based on patch by blathijs)
Feature: [Makefile] Add 'addcheck' which checks for dependencies
not added to the Mercurial repo
Feature: [Makefile] Introduce target 'distclean' which should delete
everything not found in the tarball (based on patch by blathijs)

Change: License now is only GPL v2
Change: Rename the title theme into 'OpenTTD journey'

Fix: Don't rebuild the md5sums file which one checks against
Fix: Replace invalid general midi 'Little Blue Box Car' by 'Downtown cab ride' by imuh3
Fix: Replace invalid general midi 'Smooth Groove' by 'Skydive' by imuh3
Fix: [Makefile] Don't rebuild the md5sums file which one wants to check against
Fix: Replace invalid general midi 'Little Blue Box Car'
by 'Downtown cab ride' by imuh3
Fix: Replace invalid general midi 'Smooth Groove'
by 'Skydive' by imuh3
Fix: [Makefile] Don't rebuild the md5sums file which one
wants to check against
Fix: [Makefile] Don't pack files which make no sense in a source release
Fix: [Makefile] Fail on the missing file, not on the dependency check
Fix: [Makefile] {{tag}} didn't work for some tags in readme file
Expand All @@ -60,18 +66,23 @@ Change: Replace 'Rubens Random Kingodom' by 'Run For Your Life'

Fix: Add two missing files

Update: Base set translations for Polish, Romanian, Slovak, Serbian and Turkish
Update: Base set translations for Polish, Romanian, Slovak, Serbian and
Turkish



OpenMSX 0.2.0
-------------
Change: Rename 'Theme song' into 'Smooth groove' and update its music a bit
Update: New version of 'Keep on Rolling'
Update: African, Arabic, Catalan, Danish, Estonian, Greek and Norwegian (Nynorsk) base set translations.
Update: African, Arabic, Catalan, Danish, Estonian, Greek and
Norwegian (Nynorsk) base set translations.
Feature: Add 'Busy Schedule' and 'The Fast Route'
Feature: Add 10 new songs as modern theme: Simple ride, Midnight snow run, Deep down chemistry lab, Harp harmony 'n humor,
Rubens random kingdom, Wandering dark castle, Wood whistles, Linn's basket of treats, Plain simple relax song and Mighty giant run
Feature: Add 10 new songs as modern theme:
Simple ride, Midnight snow run, Deep down chemistry lab,
Harp harmony 'n humor, Rubens random kingdom,
Wandering dark castle, Wood whistles, Linn's basket of treats,
Plain simple relax song and Mighty giant run



Expand All @@ -81,5 +92,9 @@ Feature: Modern Motion (Mr.Ksoft)
Feature: Little Blue Box Car (Hazza)
Feature: Keep on Rolling (Trolley Trev)
Feature: Theme song (Samwise)
Feature: Bulgarian, Chinese (Traditional), Croatian, Indonesian, Norwegian (Bokmal), Portuguese, Russian, Slovenian, Swedish, Dutch, Italian, French, Hungarian, Spanish, German and Czech description translations
Feature: Build system which allows building the whole set from a simple table
Feature: Bulgarian, Chinese (Traditional), Croatian, Indonesian,
Norwegian (Bokmal), Portuguese, Russian, Slovenian, Swedish,
Dutch, Italian, French, Hungarian, Spanish, German and Czech
description translations
Feature: Build system which allows building the whole set from a simple
table
4 changes: 2 additions & 2 deletions docs/license.ptxt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,8 +313,8 @@ If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type
`show w'. This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
Expand Down
101 changes: 52 additions & 49 deletions docs/readme.ptxt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,41 +25,41 @@ OpenMSX is an open source base music set for OpenTTD.
1 Installing
============

1. First, make sure that you downloaded and installed at least OpenTTD version
1.0.0 or later.
1. First, make sure that you downloaded and installed at least OpenTTD
version 1.0.0 or later.

2. Obtain OpenMSX:
There are two ways, one easy (ingame download) and one complicated by
downloading it yourself and installing it in the right place:
a) Via ingame content download:
- Go to the content download, and search for OpenMSX; it's found in
- Go to the content download, and search for OpenMSX; it's found in
the baseset category.

b) Manually:
download the latest OpenMSX package from its development homepage:
homepage: https://github.com/OpenTTD/OpenMSX
Unpack the zip file into the OpenTTD 'baseset' directory (see section 4.2
of the OpenTTD readme for a detailed treatise on all data dirs OpenTTD
recognizes).
- An OpenTTD folder in your user account's home directory:
Windows:
C:\My Documents (95, 98, ME)
C:\Documents and Settings\<username>\My Documents\OpenTTD (2000, XP)
C:\Users\<username>\Documents\OpenTTD (Vista, 7)
macOS: ~/Documents/OpenTTD
download the latest OpenMSX package from its development homepage:
homepage: https://github.com/OpenTTD/OpenMSX
Unpack the zip file into the OpenTTD 'baseset' directory
(see the OpenTTD readme for a detailed treatise on
all data dirs OpenTTD recognizes).
- An OpenTTD folder in your user account's home directory:
Windows:
C:\My Documents (95, 98, ME)
C:\Documents and Settings\<user>\My Documents\OpenTTD (2000, XP)
C:\Users\<user>\Documents\OpenTTD (Vista, 7)
macOS: ~/Documents/OpenTTD
GNU/Linux: ~/.openttd
- The OpenTTD installation directory.
- The OpenTTD installation directory.

3. In the main menu of the game, click the Game Options button. The Game
Options dialog will appear.

4. Select OpenMSX from the drop-down list below Base Music set if that's not
selected already (bottom left of window). Close the window using the × in the
upper left corner.
selected already (bottom left of window). Close the window using the × in
the upper left corner.

Now that wasn't so hard, was it? Anyways, if you're having trouble getting
OpenMSX to work, please file a detailed report on what you did, what error
messages you got and where you got stuck at our bug tracker at
Now that wasn't so hard, was it? Anyways, if you're having trouble
getting OpenMSX to work, please file a detailed report on what you did,
what error messages you got and where you got stuck at our bug tracker at
https://github.com/OpenTTD/OpenMSX/issues
or at
https://www.tt-forums.net
Expand All @@ -73,15 +73,16 @@ OpenMSX is an open source base music set for OpenTTD.
======================================

(Windows)
Depending upon the hardware and the music driver used, OpenTTD may have problems
to playback some songs without error or that it may happen that subsequent sound
output is changed in a detrimental way. The latter is especially know to happen
with the windows "dmusic" sound driver. You may want to try the "win32" music
driver, if you have problems with Windows' default dmusic driver. Search your
openttd.cfg for "musicdriver" and change the line to "musidriver = win32".
Depending upon the hardware and the music driver used, OpenTTD may have
problems to playback some songs without error or that it may happen that
subsequent sound output is changed in a detrimental way. The latter is
especially know to happen with the windows "dmusic" sound driver. You may
want to try the "win32" music driver, if you have problems with Windows'
default dmusic driver. Search your openttd.cfg for "musicdriver" and change
the line to "musidriver = win32".
Consult also the OpenTTD readme for available options and its known-bugs.txt
for a more detailed and possibly more up to date description of Windows music
driver issues.
for a more detailed and possibly more up to date description of Windows
music driver issues.

(GNU/Linux)
If you cannot get music to play, it might be because your system does not
Expand Down Expand Up @@ -111,26 +112,26 @@ and you might additionally want a text editor of your choice and possibly a
programme capable of creating and editing midi files.

On Windows: We advise to get a MinGW development environment.
For more detailed instructions, see our guide
at http://dev.openttdcoop.org/projects/home/wiki and the very extensive and
detailed installation instructions on the MinGW wiki at
http://www.mingw.org/wiki/Getting_Started
For more detailed instructions, see the installation instructions on the
MinGW wiki at
http://www.mingw.org/wiki/Getting_Started

On GNU/Linux: Your system probably has most of these things installed,
but if not, all of these things should be easy to install if your system
has a software package manager.

On macOS: Install the developers tools. Git is easiest installed via
macports: sudo port install git
macports:
sudo port install git

The use of Git is strongly encouraged as only that allows to keep track of
changes.

Once all tools are installed, get a checkout of the repository and you can build
OpenMSX using 'make'. The following targets are available:
Once all tools are installed, get a checkout of the repository and you can
build OpenMSX using 'make'. The following targets are available:
- all: builds all grfs and the obm file
- install: build and then copy OpenMSX in your OpenTTD music directory. Use
Makefile.local to specify a different path
- install: build and then copy OpenMSX in your OpenTTD music directory.
Use Makefile.local to specify a different path
- clean: cleans all generated files
- mrproper: also cleans generated directories
- bundle_src: create a source tarball
Expand All @@ -140,10 +141,11 @@ Makefile.local to specify a different path
- check: checks the md5 sums of the built grf and obg files against those of
the official release versions

Given the usual case that you modify something within OpenMSX and want to test
that, a simple 'make install' should suffice and you can immediately test the
changes ingame, if you selected the nightly version of OpenMSX. Given default
paths, a 'make install' will overwrite a previous nightly version of OpenMSX.
Given the usual case that you modify something within OpenMSX and want to
test that, a simple 'make install' should suffice and you can immediately
test the changes ingame, if you selected the nightly version of OpenMSX.
Given default paths, a 'make install' will overwrite a previous nightly
version of OpenMSX.
Mind to re-start OpenTTD as it needs to re-read the files.


Expand All @@ -154,17 +156,18 @@ Mind to re-start OpenTTD as it needs to re-read the files.
The OpenMSX music set for OpenTTD Copyright (C) 2010-2021 OpenMSX Authors
(see below or in the source in themes.list) and is licensed under GPL v2.

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License version 2 as published by the Free
Software Foundation.
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 as published by
the Free Software Foundation.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.

You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 1 Franklin
Street, Fifth Floor, Boston, MA 02110-1301 USA.
this program; if not, write to the Free Software Foundation, Inc.,
1 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.



Expand Down