Merge pull request #347 from yamacir-kit/environment

Environment

Author: yamacir-kit

.github/workflows/build.yaml

@@ -19,10 +19,6 @@ jobs:
       - uses: actions/checkout@v2
       - run: ./script/setup.sh --all
       - run: cmake -B build -DCMAKE_BUILD_TYPE=${{ matrix.configuration }}
-      - run: cmake --build build --parallel $(nproc)
-      - run: cmake --build build --parallel $(nproc) --target test -- ARGS=-j"$(nproc)"
-      - run: cmake --build build --parallel $(nproc) --target package
-      - run: sudo apt install --yes ./build/meevax_$(cat VERSION)_amd64.deb
+      - run: cmake --build build --target safe-install.deb
       - run: cmake -B example/build -S example -DCMAKE_BUILD_TYPE=${{ matrix.configuration }}
-      - run: cmake --build example/build --parallel $(nproc)
-      - run: cmake --build example/build --parallel $(nproc) --target test -- ARGS=-j"$(nproc)"
+      - run: cmake --build example/build --target demo

.github/workflows/release.yaml

@@ -11,7 +11,6 @@ jobs:
       - run: echo "VERSION=$(cat VERSION)" >> $GITHUB_ENV
       - run: ./script/setup.sh --required
       - run: cmake -B build -DCMAKE_BUILD_TYPE=Release
-      - run: cmake --build build
       - run: cmake --build build --target package
       - uses: actions/create-release@v1
         id: create-release

CMakeLists.txt

@@ -84,7 +84,8 @@ add_library(kernel SHARED "")
 
 add_library(${PROJECT_NAME}::kernel ALIAS kernel)
 
-file(GLOB_RECURSE ${PROJECT_NAME}_KERNEL_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/*/*.cpp)
+file(GLOB_RECURSE ${PROJECT_NAME}_KERNEL_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/src/*/*.cpp
+                                                 ${CMAKE_CURRENT_SOURCE_DIR}/src/standard.cpp)
 
 target_sources(kernel PRIVATE ${${PROJECT_NAME}_BASIS}
                       PRIVATE ${${PROJECT_NAME}_KERNEL_SOURCES})
@@ -193,10 +194,17 @@ foreach(FILEPATH IN LISTS ${PROJECT_NAME}_TEST_CXX)
                    ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/assert-${FILENAME})
 endforeach()
 
-# ---- Target all+ -------------------------------------------------------------
+# ---- Additional Targets ------------------------------------------------------
 
 execute_process(COMMAND nproc OUTPUT_VARIABLE NPROC)
 
-add_custom_target(all+ COMMAND make all -j ${NPROC}
-                       COMMAND ${CMAKE_CTEST_COMMAND} -j ${NPROC}
-                       COMMAND ${CMAKE_CPACK_COMMAND})
+add_custom_target(install.deb
+  COMMAND make -j ${NPROC}
+  COMMAND ${CMAKE_CPACK_COMMAND}
+  COMMAND sudo apt install ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_${PROJECT_VERSION}_amd64.deb)
+
+add_custom_target(safe-install.deb
+  COMMAND make -j ${NPROC}
+  COMMAND ${CMAKE_CTEST_COMMAND} -j ${NPROC}
+  COMMAND ${CMAKE_CPACK_COMMAND}
+  COMMAND sudo apt install ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}_${PROJECT_VERSION}_amd64.deb)

README.md

@@ -1,64 +1,45 @@
-<h1 align="center">
-  <a href="https://github.com/yamacir-kit/meevax/">
-    <img src="https://github.com/yamacir-kit/meevax/wiki/svg/meevax-logo.v8.png" alt="Meevax Lisp System"/>
-  </a>
-</h1>
-
-<h3 align="center">
+<p align="center">
+  <img src="https://github.com/yamacir-kit/meevax/wiki/svg/meevax-logo.v8.png" alt="Meevax Lisp System"/>
+  <br/>
   <img src="https://github.com/yamacir-kit/meevax/wiki/svg/description.png" alt="A programmable programming lanugage."/>
-</h3>
-
+</p>
+<hr color=#c1ab05/>
 <p align="center">
   <img src="https://github.com/yamacir-kit/meevax/actions/workflows/build.yaml/badge.svg"/>
   <img src="https://github.com/yamacir-kit/meevax/actions/workflows/release.yaml/badge.svg"/>
 </p>
+<p align="center">
+  <b><a href="#Overview" >Overview</a></b> &nbsp;|&nbsp;
+  <b><a href="#Requirements">Requirements</a></b> &nbsp;|&nbsp;
+  <b><a href="#Installation">Installation</a></b> &nbsp;|&nbsp;
+  <b><a href="#Usage">Usage</a></b> &nbsp;|&nbsp;
+  <b><a href="#License">License</a></b> &nbsp;|&nbsp;
+  <b><a href="#References">References</a></b>
+</p>
 
-Meevax is a programming language classified as Lisp-1.
-This language inherits the minimalism of Scheme, which is summarized in the following sentence:
+## Overview
 
 > Programming languages should be designed not by piling feature on top of feature, but by removing the weaknesses and restrictions that make additional features appear necessary.
-> <p align="right"> --
->   <a href="https://bitbucket.org/cowan/r7rs/raw/tip/rnrs/r7rs.pdf"> Revised<sup>7</sup> Report on the Algorithmic Language Scheme [1] </a>
-> </p>
-
-Meevax provides
+> <div align="right">
+>   Revised<sup>7</sup> Report on the Algorithmic Language Scheme [1]
+> </div>
 
-*   not "**ad-hoc informally-specified**",
-*   not "**bug-ridden**",
-*   ~~not "**slow**"~~
+Meevax is an implementation of Lisp-1 programming language, supporting subset of the [Scheme](http://www.scheme-reports.org/) (R7RS) and [SRFI](https://srfi.schemers.org/)s.
 
-subset of **R7RS Scheme** implementation.
-
-<br/>
-
-
-## Contents
-
-0. [Overview](#Overview)
-1. [Requirements](#Requirements)
-2. [Installation](#Installation)
-3. [References](#References)
-4. [Resources](#Resources)
-
-<br/>
-
-
-## Overview
+### Releases
 
-There is no stable version.
+Latest release is [here](https://github.com/yamacir-kit/meevax/releases).
 
-Development HEAD: 0.3.545.
+### Features
 
-### Characteristic Features
-
--   **Architecture** - TR-SECD virtual machine.
--   **Modern C++ compatible dynamic typing** - Meevax provides RTTI-based language runtime library.
+-   Architecture - TR-SECD virtual machine.
+-   Modern C++ compatible dynamic typing - Meevax provides RTTI-based language runtime library.
 
 ### Standards
 
-An subset of R7RS-small.
+Subset of R7RS-small.
 
-### SRFI
+### SRFIs
 
 | Number                                                | Name                                                     | Import from | Note       |
 |------------------------------------------------------:|:---------------------------------------------------------|:------------|:-----------|
@@ -74,59 +55,102 @@ An subset of R7RS-small.
 |  [78](https://srfi.schemers.org/srfi-78/srfi-78.html) | Lightweight testing                                      | built-in    | Except `check-ec`
 |  [87](https://srfi.schemers.org/srfi-87/srfi-87.html) | => in case clauses                                       | built-in    | R7RS 4.2.1 |
 
-<br/>
-
-
 ## Requirements
 
-### System
+### Software
 
--   Ubuntu 18.04 or later
+-   [GCC](https://gcc.gnu.org/) (>= 7.5.0) or [Clang](https://clang.llvm.org/) (>= 9.0.0)
+-   [CMake](https://cmake.org/) (>= 3.10.2)
+-   [GNU Make](http://savannah.gnu.org/projects/make)
+-   [GNU Binutils](https://www.gnu.org/software/binutils/)
+-   [GNU Multiple Precision Arithmetic Library (GMP)](https://gmplib.org/)
 
-### Tools
+To install the above software, it is easy to use the following script.
 
--   Compiler with C++17 support (GCC >= 7.5.0, Clang >= 6.0.0)
--   CMake (>= 3.10.2) <!-- Ubuntu 18.04 LTS default CMake version -->
--   GNU Make
--   GNU Binutils
--   [**GNU Multiple Precision Arithmetic Library** (GMP)](https://gmplib.org/)
+``` bash
+$ ./script/setup.sh --required
+```
 
-<br/>
+## Installation
 
+### Install
 
-## Installation
+``` bash
+$ cmake -B build -DCMAKE_BUILD_TYPE=Release
+$ cd build
+$ make install.deb
+```
 
-### Install from source
+### Uninstall
 
 ``` bash
-git clone https://github.com/yamacir-kit/meevax.git ~/.meevax && cd $_
-./script/setup.sh --all
-./script/install.sh
+$ sudo apt remove meevax
+```
+<!--
+or
+``` bash
+sudo rm -rf /usr/local/bin/meevax
+sudo rm -rf /usr/local/include/meevax
+sudo rm -rf /usr/local/lib/libmeevax*
+sudo rm -rf /usr/local/share/meevax
 ```
+-->
 
-<br/>
+### CMake targets
 
+| Target Name        | Description
+|:-------------------|:--
+| `all` (default)    | Build shared-library `libmeevax.0.3.597.so` and executable `meevax`.
+| `test`             | Test executable `meevax`.
+| `package`          | Generate debian package `meevax_0.3.597_amd64.deb`.
+| `install`          | Copy files into `/usr/local` __(1)__.
+| `install.deb`      | `all` + `package` + `sudo apt install <meevax>.deb`
+| `safe-install.deb` | `all` + `test` + `package` + `sudo apt install <meevax>.deb`
 
-## Liscence
+__(1)__ Meevax installed by `make install` cannot be uninstalled by the system's package manager (for example, `apt remove meevax`). You need to manually delete the following files to uninstall:
 
-See [LICENSE](./LICENSE)
+- `/usr/local/bin/meevax`
+- `/usr/local/include/meevax`
+- `/usr/local/lib/libmeevax*`
+- `/usr/local/share/meevax`
 
-| Name                | License                                  |
-|:--------------------|:-----------------------------------------|
-| Boost C++ Libraries | Boost Software License                   |
-| GNU MP              | GNU Lesser General Public License (LGPL) |
+## Usage
 
-<br/>
+```
+Meevax Lisp System, version 0.3.597
+
+Usage: meevax [OPTION...] [FILE...]
+
+Options:
+  -b, --batch            Suppress any system output.
+  -d, --debug            Display detailed informations for developers.
+  -e, --evaluate=STRING  Read and evaluate given STRING at configuration step.
+  -h, --help             Display this help text and exit.
+  -i, --interactive      Take over control of root syntactic-continuation.
+  -l, --load=FILENAME    Same as -e '(load FILENAME)'
+      --prompt=STRING    Same as -e '(set-prompt! STRING)'
+  -t, --trace            Display stacks of virtual machine for each steps.
+  -v, --version          Display version information and exit.
+      --verbose          Display detailed informations.
+  -w, --write=OBJECT     Same as -e '(write OBJECT)'
+```
 
+| Example                                    | Effects |
+|:-------------------------------------------|:--|
+| `$ meevax -i`                              | Start interactive session. You can exit the session by input `(exit)` or Ctrl+C or Ctrl+D.
+| `$ meevax foo.ss`                          | Evaluate a script `foo.ss`. |
+| `$ meevax -e '(+ 1 2 3)'`                  | Display `6`.
+| `$ meevax -e "(define home \"$HOME\")" -i` | Define value of shell-environment variable `$HOME` as string typed Scheme variable `home`, and then start interactive session on environment includes the variable `home`.
 
-## References
+## License
 
-- [1] A.shinn, J.Cowan, A. A. Greckler, editors, "<cite><a href="https://bitbucket.org/cowan/r7rs/raw/tip/rnrs/r7rs.pdf">Revised<sup>7</sup> Report on the Algorithmic Language Scheme</a></cite>", Technical report, 2013.
+See [LICENSE](./LICENSE).
 
-<br/>
+## References
 
+- [1] A.shinn, J.Cowan, A. A. Greckler, editors, "[Revised<sup>7</sup> Report on the Algorithmic Language Scheme](https://bitbucket.org/cowan/r7rs/raw/tip/rnrs/r7rs.pdf)", Technical report, 2013.
 
-## Resources
+### Resources
 
 *   [TinyScheme](http://tinyscheme.sourceforge.net/)
 *   [SECDR-Scheme](http://www.maroon.dti.ne.jp/nagar17/mulasame/)

VERSION

@@ -1 +1 @@
-0.3.545
+0.3.597