Skip to content

Latest commit

 

History

History
87 lines (76 loc) · 2.49 KB

README.md

File metadata and controls

87 lines (76 loc) · 2.49 KB
Raw

Yuuki Language

  • A super light weight language that supports generic OOP programming which developed during study compile principle.

TODO-List

  • Lexer
  • Parser
  • Semantic Analyse
  • Code Generation
  • VM, runtime, etc...
  • Please be aware that the project is still in early development phase.

Build

  • Please check your compiler compatibility with c++ 17 before compile
    • We need at least c++ 17 feature std::string_view in all platforms
    • We need c++ latest in Windows/VS toolchains

macOS build instructions

  • Install command-line tools:
$ xcode-select --install
  • Install CMake:
$ brew install cmake
  • Completely clone the repo in a recursively mode:
$ git clone --recursive https://github.com/AlaricGilbert/yuuki-lang
  • Go into the directory, run the compile script:
$ cd yuuki-lang
$ ./build.sh

Linux build instructions

  • Install tools (Example code in Ubuntu, GCC toolchain)
$ apt-get update
$ apt-get insatll gcc g++ cmake
  • Completely clone the repo in a recursively mode:
$ git clone --recursive https://github.com/AlaricGilbert/yuuki-lang
  • Go into the directory, run the compile script:
$ cd yuuki-lang
$ ./build.sh
  • Then you can find results of compilations under artifacts folder.

Windows build instructions

  • Goto CMake website, install CMake and add CMake into PATH

  • Completely clone the repo in a recursively mode:

PS git clone --recursive https://github.com/AlaricGilbert/yuuki-lang

Windows with MSVC tool chain

We assume that MSVC was installed correctly in this context

  • Go into the directory, run the compile script (USE POWERSHELL):
PS cd yuuki-lang
PS build.ps1

You may need to modify bypass execution settings for your Powershell

Windows with MinGW in PATH

We assume that MinGW (win32) was installed correctly in this context and added into PATH

  • Go into the directory, run the compile script:
PS cd yuuki-lang
PS mkdir build
PS cd build
PS cmake .. -G"MinGW Makefiles"
PS make

LICENSE

This project is licensed under MIT with below exceptions:

  • You are not allowed to directly submit code this repo as your coursework.

Contribution

Pull requests are welcomed!