Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Latest commit

 

History

History
88 lines (55 loc) · 2.82 KB

README.md

File metadata and controls

88 lines (55 loc) · 2.82 KB
Raw
📝 As part of our ongoing commitment to efficiently deliver value to the EOS Network, Antler has been deprecated as of January 2024. This repository will not receive future updates or support. Your questions and concerns are important to us; please direct feedback to our Antler Deprecation Feedback Tracker

ANTLER Project Tools

ANTLER Project Tools (aproj) is a set of tools to help in the generation of smart contracts intended for deployment to an Antelope blockchain.

This set of tools will help the developer create, maintain, build, and test smart contracts.

Usage

For now, please see the Intial Design Document for usage.

Runtime Dependencies

The following tools are required for aproj to work at runtime:

  • CMake v3.11

Build Dependencies

Building aproj requires the following dependencies:

  • C++20 compiler (common minimums: gcc-10 or clang-11).
  • CMake version 3.11 or greater (note the requirement here).

Additionally we recomend using ninja build for fast builds.

Submodules

Make sure your submodules are initialized and updated recursively using the command: git submodule update --init --recursive

Building

Assuming you have the other dependencies installed, from the project root, the following will build the project:

mkdir -p Build \
    && cd Build \
    && cmake .. -DCMAKE_BUILD_TYPE=Release \
    && cmake --build .

Test

Currently, the following will run some automated tests:

ninja && ninja test

Maintaining

Directories in the project root:

  • aproj: This contains the various CLI tools, all of which depend on the project library.
  • project: This is standalone library that contains the majority of implementation that creates and maintains the project.yaml file as well as initialize and populate the project's directory tree, among other things.
  • test: This direcory contains a number of unit tests. In future, it's likely to contain system level tests as well.

License

This project is licensed using the MIT License as found here.

Additionally, apack includes and depends on these libraries:

Miscellaneous

What does aproj stand for?

It's a shortening of antler-proj.

Is ANTLER an acronym?

Yes, it is. Or maybe it's a backronym?

Regardless, it's ANother TransLator Environment and Runtime.

Initial Issue

AntelopeIO/cdt#62