Skip to content

Commit

Permalink
feat: update documentation formatting and improve contributing guidel…
Browse files Browse the repository at this point in the history
…ines
  • Loading branch information
HsiangNianian committed Jan 12, 2025
1 parent 80d1377 commit a99d006
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ We use pyo3 to bradge rust and python.

This project is a rule-driven and powerful AI framework designed to support multimodal machine learning and cross-platform robot development.

We use ruff to format and lint code.
We use ruff to format and lint code, we use .rst grammar to write the README.rst and all the docstring in English.
25 changes: 12 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,39 +24,38 @@ Installation

To install **iamai**, run the following command:

```bash
pip install iamai
```
.. code-block:: bash
pip install iamai
Usage
-----

To use **iamai**, run the following command:

```bash
iamai
```
.. code-block:: bash
iamai
Contributing
------------

To contribute to **iamai**, follow these steps:

1. Fork this repository.
2. Create a branch: `git checkout -b <branch_name>`.
3. Make your changes and commit them: `git commit -m '<commit_message>'`.
4. Push to the original branch: `git push origin <project_name>/<location>`.
2. Create a branch: ``git checkout -b <branch_name>``.
3. Make your changes and commit them: ``git commit -m '<commit_message>'``.
4. Push to the original branch: ``git push origin <project_name>/<location>``.
5. Create the pull request.

Alternatively, see the GitHub documentation on [creating a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
Alternatively, see the GitHub documentation on `creating a pull request <https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request>`_.

Support
-------

If you have any questions, please contact me at [[email protected]](mailto:[email protected]).

If you have any questions, please contact me at `[email protected] <mailto:[email protected]>`_.

License
-------

This project is licensed under the AGPLv3 License. See the [COPYING](COPYING) file for details.
This project is licensed under the AGPLv3 License. See the `COPYING <COPYING>`_ file for details.

0 comments on commit a99d006

Please sign in to comment.