Skip to content

docs: update the Getting Started section in README#1430

Merged
Flouse merged 4 commits intoaxonweb3:mainfrom
Flouse:readme
Sep 13, 2023
Merged

docs: update the Getting Started section in README#1430
Flouse merged 4 commits intoaxonweb3:mainfrom
Flouse:readme

Conversation

@Flouse
Copy link
Copy Markdown
Contributor

@Flouse Flouse commented Sep 13, 2023 •
edited
Loading

What this PR does / why we need it?

This PR updates README.md and fixes #1329.

Changes

  • axonweb3/axon-devops is no longer recommended
  • remove axonweb3/axon-cli because it is no longer maintained
  • update the Getting Started section in README

What is the impact of this PR?

No Breaking Change

CI Settings

CI Usage

Tip: Check the CI you want to run below, and then comment /run-ci.

CI Switch

  • E2E Tests
  • Web3 Compatible Tests
  • OCT 1-5 And 12-15
  • OCT 6-10
  • OCT 11
  • OCT 16-19
  • v3 Core Tests

CI Description

CI Name Description
Chaos CI Test the liveness and robustness of Axon under terrible network condition
Cargo Clippy Run cargo clippy --all --all-targets --all-features
Coverage Test Get the unit test coverage report
E2E Test Run end-to-end test to check interfaces
Code Format Run cargo +nightly fmt --all -- --check and cargo sort -gwc
Web3 Compatible Test Test the Web3 compatibility of Axon
v3 Core Test Run the compatibility tests provided by Uniswap V3
OCT 1-5 | 6-10 | 11 | 12-15 | 16-19 Run the compatibility tests provided by OpenZeppelin

@Flouse Flouse requested a review from a team as a code owner September 13, 2023 07:48
@Flouse Flouse requested review from a team, KaoImin, ashuralyk, blckngm, kelisi129 and linnnsss and removed request for a team, ashuralyk and blckngm September 13, 2023 07:48
@Flouse Flouse enabled auto-merge September 13, 2023 07:59
@Flouse Flouse mentioned this pull request Sep 13, 2023
Closed
@Flouse Flouse added this pull request to the merge queue Sep 13, 2023
Merged via the queue into axonweb3:main with commit 88c9a91 Sep 13, 2023
@Flouse Flouse deleted the readme branch September 13, 2023 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@linnnsss linnnsss Awaiting requested review from linnnsss

@kelisi129 kelisi129 Awaiting requested review from kelisi129 kelisi129 was automatically assigned from axonweb3/axon-content

2 more reviewers

@KaoImin KaoImin KaoImin approved these changes

@Simon-Tl Simon-Tl Simon-Tl approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

document

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Refactor workflows/pr_lint.yml

3 participants

@Flouse @KaoImin @Simon-Tl