This repository is a website for reviewing AVM API documentation. It is deployed at avm-api.aion.network. The contents of this repository is created by building the AVM repository and copying the contents of the javadoc folder. No manual changes are made to this repository, other than this README.md file.
This repository is created when a new Aion Java Kernel build is released. To create this repository from scratch:
- Clone the latest Aion AVM repository:
git clone https://github.com/aionnetwork/AVM.git - Move into the aion directory:
cd AVM - Build the kernel:
ant - The API website now in
AVM/dist/javadoc.
The contents of that folder are then copied into this repository, where it is published by Netlify.
This repository is derived directly from:
https://github.com/aionnetwork/AVM/tree/16537d4cc2359371e1cf7222dff7b273511eb1cc/org.aion.avm.api https://github.com/aionnetwork/AVM/tree/16537d4cc2359371e1cf7222dff7b273511eb1cc/org.aion.avm.userlib
You can edit those files and then after the next build, they will be included in this repository.
Issues and pull requests against this repository will be in scope only to edit this README.md file.