Check-in [be3919ede9]

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Merge in the user guide branch.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:be3919ede983699b641a408cb379013472c0ec27
User & Date: stephanie.gawroriski 2020-07-28 22:51:41
Context
2020-07-28
22:56
Update public key. check-in: 59c32499bf user: stephanie.gawroriski tags: trunk
22:51
Merge in the user guide branch. check-in: be3919ede9 user: stephanie.gawroriski tags: trunk
22:34
More work on the user guide, likely final. Closed-Leaf check-in: f90fa85ee8 user: stephanie.gawroriski tags: wip-userguide
07:02
Backup developer notes. check-in: 9f5f8a5064 user: squirreljme.automation tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to .circleci/config.yml.

335
336
337
338
339
340
341


























342
343
344
345
346
347
348
...
364
365
366
367
368
369
370








          when: always
      - store_test_results:
          path: ~/test-results
      - store_artifacts:
          path: ~/test-results/junit
      - store_artifacts:
          path: ~/test-results/nps



























workflows:
  version: 2
  tests:
    jobs:
      - build_windows
      - build_linux
................................................................................
            - ratufacoat_build_windows
      - ratufacoat_build_linux:
          requires:
            - build_linux
      - ratufacoat_build_macosx:
          requires:
            - build_macosx















>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>







 







>
>
>
>
>
>
>
>
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
...
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
          when: always
      - store_test_results:
          path: ~/test-results
      - store_artifacts:
          path: ~/test-results/junit
      - store_artifacts:
          path: ~/test-results/nps
  ################################### USERS ##################################
  export_user_guide:
    executor: buildenv
    steps:
      - checkout
      - run:
          name: Checkout Wiki
          command: git clone git@github.com:SquirrelJME/SquirrelJME.wiki.git /tmp/wiki
      - run:
          name: Wikify
          command: .circleci/squirreljme-wikify-user-guide.sh "$(pwd)" "/tmp/wiki"
      - run:
          name: Update Git User
          command: |
            cd "/tmp/wiki" && git config user.name "SquirrelJME Automation" && git config user.email "xerthesquirrel+squirreljme@gmail.com"
      - run:
          name: Commit changes
          command: |
            cd "/tmp/wiki" && git commit -m "Synchronize User-Guide" || echo "Ignoring commit."
      - add_ssh_keys:
          fingerprints:
            - "26:b8:ae:4d:53:64:4c:6a:59:3d:a6:60:44:90:9d:6c"
      - run:
          name: Push changes
          command: |
            cd "/tmp/wiki" && git push

workflows:
  version: 2
  tests:
    jobs:
      - build_windows
      - build_linux
................................................................................
            - ratufacoat_build_windows
      - ratufacoat_build_linux:
          requires:
            - build_linux
      - ratufacoat_build_macosx:
          requires:
            - build_macosx
  friendliness:
    jobs:
      - export_user_guide:
          filters:
            branches:
              only:
                - trunk
                - wip-userguide

Added .circleci/squirreljme-wikify-user-guide.sh.





































































































































































































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
#!/bin/sh
# ---------------------------------------------------------------------------
# Multi-Phasic Applications: SquirrelJME
#     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
#     Copyright (C) Multi-Phasic Applications <multiphasicapps.net>
# ---------------------------------------------------------------------------
# SquirrelJME is under the GNU General Public License v3+, or later.
# See license.mkd for licensing and copyright information.
# ---------------------------------------------------------------------------
# DESCRIPTION: Wikifies SquirrelJME for GitHub, since GitHub uses a different
# format for their Wikis...

# Must be valid!
if [ "$#" -lt "2" ]
then
	echo "Usage: $0 [repo] [wiki-git-repo]"
	exit 1
fi

# These are directories
__foss="$1/assets/user-guide"
__gith="$2"

# These both must be directories
if [ ! -d "$__foss" ] || [ ! -d "$__gith" ]
then
	echo "Both arguments must be directories."
	exit 1
fi

# Target must be a Git repo
if [ ! -d "$__gith/.git" ]
then
	echo "Target not a Git repository."
	exit 1
fi

# Convert to GitHub name
__toGitHubName()
{
	__srcName="$1"
	
	if [ "$__srcName" = "readme.mkd" ]
	then
		echo "Home.markdown"
	else
		echo "$__srcName" | sed 's/\.mkd$/\.markdown/'
	fi
}

# Convert to Fossil name
__toFossilName()
{
	__srcName="$1"
	
	if [ "$__srcName" = "Home.markdown" ]
	then
		echo "readme.mkd"
	else
		echo "$__srcName" | sed 's/\.markdown$/\.mkd/'
	fi
}

# Remove any other old files
find "$__gith" -type f | grep -e '\.mkd$' -e '\.md$' | while read __githFile
do
	echo "Removing old file $__githFile..."
	(cd "$__gith" && git rm -f "$__githFile")
done

# Remove any files which are missing
find "$__gith" -type f | grep '\.markdown$' | while read __githFile
do
	__baseGith="$(basename "$__githFile")"
	__baseFoss="$(__toFossilName "$__baseGith")"
	
	# The file may be in the root of the project or elsewhere...
	if ! find "$__foss/" -type f | grep "$__baseFoss" > /dev/null
	then
		echo "Removing file $__githFile (aka $__baseFoss)..."
		
		(cd "$__gith" && git rm -f "$__githFile")
	fi
done

# Copy and convert the files for GitHub's Wiki
find "$__foss" -type f | grep '\.mkd$' | while read __fossFile
do
	__baseFoss="$(basename "$__fossFile")"
	__baseGith="$(__toGitHubName "$__baseFoss")"
	
	echo "Converting $__baseFoss to $__baseGith..."
	
	# Links need to be properly converted or they will be lost
	sed 's/(readme\.mkd)/(Home)/g' < "$__fossFile" | \
		sed 's/(\([^.]*\)\.mkd)/(\1)/g' > "$__gith/$__baseGith"
	(cd "$__gith" && git add "$__gith/$__baseGith")
done

Added assets/user-guide/.github/_Footer.mkd.



>
1
_You are viewing the **SquirrelJME** user guide!_

Added assets/user-guide/.github/_Sidebar.mkd.





















>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
**Table of Contents**

 * [Home](readme.mkd)

_____________________________________________________________________________
 
 * [Frequently Asked Questions](faq.mkd)
 * [List of errors](error-list.mkd)

_____________________________________________________________________________

Added assets/user-guide/error-list.mkd.









>
>
>
>
1
2
3
4
# Error List

This file is currently a place holder and in the future all of the errors
will be placed here accordingly.

Added assets/user-guide/faq.mkd.



































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Frequently Asked Questions

 * ***Q***: **PhoneME**'s source code is available, why do you not use that
   to make development faster?
   * ***A***: One of the major things is that **SquirrelJME** is a clean room
     reverse engineering and re-implementation based on books, API
     documentation, and observations. As such, it is not possible to use the
     code from this standpoint. Additionally, **PhoneME** is only a reference
     implementation and it would only be a base starting point so it would
     not bring much as vendors would have heavily modified it or written
     their own APIs. So from these, even if it were possible to use the
     project it would bring no true benefits.
 * ***Q***: What are the errors with `XX11`?
   * ***A***: To conserve space, **SquirrelJME** uses compactified error
     codes which are stored in an [error directory](error-list.mkd), this is
     so that descriptive messages can be stored externally without there
     being additional space being used by the message.

Added assets/user-guide/readme.mkd.



































>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# SquirrelJME User Guide

Hello! Thank you for trying **SquirrelJME**, we hope that you enjoy it! This
guide is intended to make it easier to use **SquirrelJME** so you can have
some fun with it and otherwise!

 * Main Website: <https://squirreljme.cc/>

You may view this guide on the following:

 * [SquirrelJME.cc](https://squirreljme.cc/doc/trunk/assets/user-guide/readme.mkd)
 * [GitHub](https://github.com/SquirrelJME/SquirrelJME/wiki)

## Table of Contents

 * [Frequently Asked Questions](faq.mkd)
 * [List of errors](error-list.mkd)

Changes to buildSrc/src/main/java/cc/squirreljme/plugin/ErrorCodeManager.java.

6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import org.gradle.api.Project;

/**
 * This is used to manage the list of errors and otherwise.
 *
 * @since 2020/02/22
 */
public final class ErrorCodeManager
{
	/** The project for discovery. */
	protected final Project project;







|







6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeMap;
import java.util.TreeSet;
import org.gradle.api.Project;

/**
 * This is a mapping of error codes to projects.
 *
 * @since 2020/02/22
 */
public final class ErrorCodeManager
{
	/** The project for discovery. */
	protected final Project project;

Changes to buildSrc/src/main/java/cc/squirreljme/plugin/ErrorListManager.java.

12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import java.util.TreeMap;
import org.gradle.api.Project;
import org.gradle.api.file.FileTree;
import org.gradle.api.plugins.JavaPluginConvention;
import org.gradle.api.tasks.SourceSet;

/**
 * This is used to get the error lists from a project.
 *
 * @since 2020/02/22
 */
public final class ErrorListManager
{
	/** The project to manage the list for. */
	protected final Project project;







|







12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
import java.util.TreeMap;
import org.gradle.api.Project;
import org.gradle.api.file.FileTree;
import org.gradle.api.plugins.JavaPluginConvention;
import org.gradle.api.tasks.SourceSet;

/**
 * This is a mapping of individual error codes for a project.
 *
 * @since 2020/02/22
 */
public final class ErrorListManager
{
	/** The project to manage the list for. */
	protected final Project project;

Changes to readme.mkd.

50
51
52
53
54
55
56
57
58
59
60

61
62
63
64
65
66
67
   https://img.shields.io/docker/automated/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme)
 * [![Docker Build](
   https://img.shields.io/docker/build/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
 * [![Download SquirrelJME](
   https://img.shields.io/sourceforge/dm/squirreljme.svg)](
   https://sourceforge.net/projects/squirreljme/files/latest/download)

Information:


 * [Code of Conduct](code-of-conduct.mkd)
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
   * _Fonts_ : SIL Open Font License Version 1.1
 * [Contributing to SquirrelJME](contributing.mkd)
 * _End-User Documents_







|



>







50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
   https://img.shields.io/docker/automated/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme)
 * [![Docker Build](
   https://img.shields.io/docker/build/xerthesquirrel/squirreljme)](
   https://hub.docker.com/r/xerthesquirrel/squirreljme/builds)
 * [![Download SquirrelJME](
   https://img.shields.io/sourceforge/dm/squirreljme.svg)](
   https://sourceforge.net/projects/squirreljme/files/)

Information:

 * [User Guide](assets/user-guide/readme.mkd)
 * [Code of Conduct](code-of-conduct.mkd)
 * [License](license.mkd)
   * _Source_: GNU General Public License, Version 3 or later
   * _Assets_: Creative Commons CC-BY-SA 4.0
   * _Fonts_ : SIL Open Font License Version 1.1
 * [Contributing to SquirrelJME](contributing.mkd)
 * _End-User Documents_