Skip to content

Commit

Permalink
📝 Update README.md
Browse files Browse the repository at this point in the history
Add contributing section and update links to new repo owner AIMA-Dev
  • Loading branch information
NoaSecond authored Jun 18, 2024
1 parent bbff233 commit 48f0f00
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

Industrial application to control and monitor the "MiniCyc" particle accelerator (Cyclotron) designed by AIMA Developpement

Uses [AutoCopyright-v1.0](https://github.com/YoruKiwi/AutoCopyright)
Uses [AutoCopyright](https://github.com/YoruKiwi/AutoCopyright)


![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/YoruKiwi/AIMA-MiniCyc/codeql.yml?label=CI-Security)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/AIMA-Dev/AIMA-MiniCyc/codeql.yml?label=CI-Security)


## Setup
Expand All @@ -21,3 +21,14 @@ To run the MiniCyc application, follow these steps:
- Password: ```admin```

Make sure to replace admin with the appropriate username and password if you have modified the default settings in your Grafana configuration.

## Contributing

If you would like to contribute to this project, please follow these guidelines:

1. Fork the repository
2. Create a new branch: `git checkout -b my-feature`
3. Make your changes and commit them: `git commit -am 'Add some feature'` note that your commit message may start with a [gitmoji](https://gitmoji.dev/)
4. Push the branch to your forked repository: `git push origin my-feature`
5. Submit a pull request

0 comments on commit 48f0f00

Please sign in to comment.