-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: update documentation formatting and improve contributing guidel…
…ines
- Loading branch information
1 parent
80d1377
commit a99d006
Showing
2 changed files
with
13 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. |