Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mackierx111 committed Oct 24, 2022
1 parent 3ff61fb commit 57aab75
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
11 changes: 11 additions & 0 deletions docs/DeveloperGuide/HowToContribution/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to Contribution

Everyone is welcome !

1. Create a derived branch (`feature/***`) from the `develop` branch.
2. Create a pull request for the `develop` branch.

see also [AWSIM document - Git branch](https://tier4.github.io/AWSIM/ProjectGuide/GitBranch/)

We recommend microsoft's [C# coding convention](https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions?redirectedfrom=MSDN).
However, if the logic of the code is good, it does not matter if coding conventions are not followed.
2 changes: 1 addition & 1 deletion docs/GettingStarted/QuickStartDemo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ fi
3. Download and Run AWSIM Demo binary.
1. Download `AWSIM_vXXX.zip` and Unzip.
[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.0/AWSIM_v1.0.0.zip){.md-button .md-button--primary}
[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.1/AWSIM_v1.0.1.zip){.md-button .md-button--primary}
2. Allow permission.
Expand Down
4 changes: 0 additions & 4 deletions docs/ProjectGuide/GitBranch/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Git branch

!!! warning

We have not started this branch operation yet, we will start it after the main branch is stable.

## Branches

|branch|explain|
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ AWSIM is the best scene simulator for [Autoware](https://github.com/autowarefoun

## Download demo binary

[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.0/AWSIM_v1.0.0.zip){.md-button .md-button--primary}
[Download AWSIM Demo for ubuntu](https://github.com/tier4/AWSIM/releases/download/v1.0.1/AWSIM_v1.0.1.zip){.md-button .md-button--primary}

Please try the AWSIM demo binary first!
you can find a tutorial on the [Quick start demo](./GettingStarted/QuickStartDemo/index.md) page.
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ nav:
- Add custom ROS2 msg type: Components/ROS2/AddCustomROS2MessageType/index.md

- Developer guide:
- How to Contribution: DeveloperGuide/HowToContribution/index.md
- Trouble shooting: DeveloperGuide/TroubleShooting/index.md
- Documentation: DeveloperGuide/Documentation/index.md
- License : DeveloperGuide/License/index.md
Expand Down

0 comments on commit 57aab75

Please sign in to comment.