https://github.com/aerium-network/aip
A Aerium Improvement Proposal, or AIP, is a design document that provides information or describes a new feature for the Aerium blockchain.
https://github.com/aerium-network/aip
blockchain network proposal proposals
Last synced: 5 months ago
JSON representation
A Aerium Improvement Proposal, or AIP, is a design document that provides information or describes a new feature for the Aerium blockchain.
- Host: GitHub
- URL: https://github.com/aerium-network/aip
- Owner: aerium-network
- License: cc0-1.0
- Created: 2025-09-09T15:27:18.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-10-15T06:02:09.000Z (8 months ago)
- Last Synced: 2025-10-15T17:26:45.573Z (8 months ago)
- Topics: blockchain, network, proposal, proposals
- Language: HTML
- Homepage: https://aip.aerium.dev
- Size: 573 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Aerium Improvement Proposals (AIPs)
AIPs, or Aerium Improvement Proposals, define standards and guidelines to
improve the Aerium project.
AIPs are designed to be a transparent and collaborative way to propose and
discuss changes to the Aerium network.
The [AIP-1](https://aip.aerium.dev/AIPs/aip-1) defines the proposal workflows.
The [status page](https://aip.aerium.dev) tracks and lists all AIPs in this repository.
## Running Locally
To get started, install [Jekyll](https://jekyllrb.com/docs/installation/), first.
Additionally, make sure to install [Yarn](https://yarnpkg.com/)
for efficient dependency management, including [Bootstrap](https://getbootstrap.com/).
Now, clone this repository and run it locally using the following commands:
```zsh
git clone git@github.com:aerium-network/aip.git
cd aip
yarn install ## To install bootstrap
bundle install
bundle exec jekyll serve
```
## Markdown
Markdown is a lightweight markup language that uses plain text formatting syntax to convert text into HTML,
making it easy to read and write for web content.
### Linting
Markdown linting helps ensure consistent style and formatting, detects syntax errors, improves readability,
and maintains best practices in Markdown documents.
To lint Markdown files, you can use the `mdl` ([MarkdownLint](https://github.com/DavidAnson/markdownlint)) command-line tool.
This tool checks your Markdown files against a set of rules and provides feedback on any issues found.
To install `mdl`, first you need to install [Ruby](https://www.ruby-lang.org/en/documentation/installation/).
Once you ensure Ruby installed on your system, you can install `mdl` by running:
```sh
gem install mdl
```
Then you can lint your Markdown files with the following command:
```sh
mdl --style=config/.mdlrc.rb ./AIPs
```
This command will check all documents in the `AIPs` folder for any linting issues and output them in the terminal.