Formatting README.md and HACKING.md

Author: ktakashi

HACKING HACKING.mdHACKING renamed to HACKING.md

@@ -116,6 +116,7 @@ you run the command.
 - SpecialCasing.txt
 - UnicodeData.txt
 - WordBreakProperty.txt
+- emoji-data.txt
 
 Above Unicode files can be downloaded from the Unicode FTP site:
 [ftp.unicode.org](ftp://ftp.unicode.org/Public/17.0.0/).  Currently,

README.md

@@ -3,10 +3,7 @@
 [![Sagittarius CI](https://github.com/ktakashi/sagittarius-scheme/actions/workflows/ci.yml/badge.svg)](https://github.com/ktakashi/sagittarius-scheme/actions/workflows/ci.yml)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/ktakashi/sagittarius-scheme/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/ktakashi/sagittarius-scheme/tree/master)
 
-# What is this?
-
-This is a free Scheme implementation, supporting R6RS and R7RS
-specification.
+This is a Scheme implementation, supporting R6RS and R7RS specification.
 
 # How to build and install?
 
@@ -25,9 +22,11 @@ install to default location, run the following commands in the
 directory where all distributed files are expanded (c.f. By default
 it'd be `sagittarius-X.X.X`, `X.X.X` is the version you downloaded):
 
-    % cmake .
-    % make
-    % make install
+```shell
+cmake .
+make
+make install
+```
 
 Following sections describes more details.
 
@@ -43,7 +42,9 @@ Sagittarius depends on the following libraries.
 If you are using Linux which supports `apt`, then you can simply
 execute the following command:
 
-    % apt install libgc-dev, zlib1g-dev libffi-dev libssl-dev libpam0g-dev
+```shell
+apt install libgc-dev, zlib1g-dev libffi-dev libssl-dev libpam0g-dev
+```
 
 ### Manual installation of Boehm GC
 
@@ -55,12 +56,14 @@ If you are too lazy to download the archive file of GC, CMake will
 download it for you.  Make sure to run the following commands from in
 GC directory:
 
-    % ./configure \
-          --enable-threads=pthreads   \
-          --enable-parallel-mark      \
-          --enable-large-config
-    % make
-    % make install
+```shell
+./configure \
+    --enable-threads=pthreads   \
+    --enable-parallel-mark      \
+    --enable-large-config
+make
+make install
+```
 
 Note: most of the Linux distributions already have Boehm GC in their
 package management system, such as `apt-get`.  I recommend to use it
@@ -71,36 +74,46 @@ for security reason.
 After installing CMake and dependent libraries, you are ready to build
 Sagittarius; type the following command:
 
-    % cmake .
+```shell
+cmake .
+```
 
 Note: The above command assumes you are in the source directory.
 
 It is possible to build Sagittarius in a directory that is not the top
 source directory of the distributed package (out-of-tree building);
 for example:
 
-    % mkdir build
-    % cd build
-    % cmake ${path to Sagittarius' source directory}
-    % make
+```shell
+mkdir build
+cd build
+cmake ${path to Sagittarius' source directory}
+make
+```
 
 To run the tests, specify `test` target.
 
-    % make test
+```shell
+make test
+```
 
 Or, alternatively, you can also use `ctest`. This is convenient to
 test individual tests.
 
 To install Sagittarius non default location, you need to specify
 `CMAKE_INSTALL_PREFIX` variable.
 
-    % cmake . -DCMAKE_INSTALL_PREFIX=/path/to/install
+```shell
+cmake . -DCMAKE_INSTALL_PREFIX=/path/to/install
+```
 
 On some environment, there are 64 bits runtime specific directories
 such as `lib64`. To install Sagittarius runtime in the directory, then
 you can specify `LIB_DIR` variable as the following:
 
-    % cmake . -DLIB_DIR=lib64
+```shell
+cmake . -DLIB_DIR=lib64
+```
 
 Then the runtime install directoy will be
 `CMAKE_INSTALL_PREFIX/LIB_DIR`.  There are also the variables to
@@ -112,23 +125,29 @@ Since 0.5.6, Sagittarius's REPL is renamed to `sagittarius` and legacy
 `sash` is kept as a symbolic link. If you don't need the symbolic link
 then you can put the `INSTALL_SYMLINK` option off as the following:
 
-    % cmake . -DINSTALL_SYMLINK=0
+```shell
+cmake . -DINSTALL_SYMLINK=0
+```
 
 After a successful compilation, it is possible to install Sagittarius
 to the location specified by `CMAKE_INSTALL_PREFIX` or default system
 location if it's not specified with the command:
 
-    % make install
+```shell
+make install
+```
 
 After installation, you might need to run `ldconfig` to run
 Sagittarius properly.
 
 Note: For some reason, you might want to build a 32-bit runtime on a
 64-bit platform.  The following command can be used for this purpose;
 
-    % cmake . \
-        -DCMAKE_CXX_COMPILER=${your 32 bit C++ compiler} \
-        -DCMAKE_C_COMPILER={your 32 bit C compiler}
+```shell
+cmake . \
+   -DCMAKE_CXX_COMPILER=${your 32 bit C++ compiler} \
+   -DCMAKE_C_COMPILER={your 32 bit C compiler}
+```
 
 Make sure you have all the required 32-bit executables and libraries.
 
@@ -137,22 +156,28 @@ Make sure you have all the required 32-bit executables and libraries.
 Only with Homebrew is tested. A user can install sagittarius directly with
 homebrew, via
 
-    $ brew install sagittarius-scheme
+```shell
+brew install sagittarius-scheme
+```
 
 Alternately, the user can install the following dependencies and then make
 sagittarius locally.
 
 Installing libffi, CMake, Boehm GC and OpenSSL.
 
-    $ brew install libffi cmake bdw-gc openssl
+```shell
+brew install libffi cmake bdw-gc openssl
+```
 
 After installing dependent libraries, the rest of the process are the same
 as Unix-like environment.
 
 If `cmake` can't find `libffi`, then you can specify the location via
 `FFI_LIBRARY_DIR` option like the following.
 
-    $ cmake . -DFFI_LIBRARY_DIR=/opt/homebrew/Cellar/libffi/3.4.6/lib
+```shell
+cmake . -DFFI_LIBRARY_DIR=/opt/homebrew/Cellar/libffi/3.4.6/lib
+```
 
 Note: some Mac OS X environment may not be able to find `ar` command
 because `/usr/bin/gcc` is identical as `/usr/bin/clang`. In that case,
@@ -190,22 +215,31 @@ innosetup for it. Please install it.
 
  - [Inno Setup](http://www.jrsoftware.org/)
 
-You need to install MSVC preferably Visual Studio 2010 or higher.  And
-if you use `cmake-gui`, it will be much easier.  Run `Visual Studio
-Command Prompt` and go to the directory which Sagittarius source codes
-are expanded.
+You need to install MSVC preferably Visual Studio 2010 or higher. Run
+`Visual Studio Command Prompt` and go to the directory which Sagittarius
+source codes are expanded.
 
-If you prefer to use `cmake` instead of `cmake-gui`, then the
-following command needs to be executed:
+### For NMake
 
-    % cmake . -G"NMake Makefiles"
+```bat
+cmake . -G"NMake Makefiles"
+nmake
+nmake test
+```
 
-Specifying `-DDEBUG_VERSION=OFF` enables MSVC optimisations.
+### For Ninja
 
-The final commands are almost the same as in Unix-like environments.
+```bat
+cmake . -G"Ninja"
+ninja
+```
 
-    % nmake
-    % nmake test
+For Ninja, you can build with multiple processor by specifying `-j` option.
+For example:
+```bat
+rem This build Sagittarius with 8 processes
+ninja -j8
+```
 
 After these commands, you move to the `win/` directory and double
 click the file `innosetup.iss`.  Go to [Build] - [Compile], then it
@@ -218,15 +252,11 @@ Experimentally, we support other build tools. Below are the supported ones:
 
 - MSBuild
   ```bat
-  % cmake .
-  % msbuild /p:Configuration=Release Sagittarius.sln
-  ```
-- Ninja
-  ```bat
-  % cmake . -G"Ninja"
-  % ninja
+  cmake .
+  msbuild /p:Configuration=Release Sagittarius.sln
   ```
 
+
 ### Supporting platform
 
 | OS      | x86 | amd64 | ARM64 | ARM | ppc64le |
@@ -248,7 +278,7 @@ you can use `ctest` command. For example, the below command shows the output
 of the test execution when the test failed.
 
 ```shell
-% ctest --output-on-failure
+ctest --output-on-failure
 ```
 
 For more options, please refer the official document of the
@@ -268,7 +298,7 @@ Or you can report it on Google group.
 
 # How to develop it?
 
-See HACKING file.
+See [HACKING.md](HACKING.md) file.
 
 <!-- end of file
 Local Variables: