Skip to content

Commit b660e8d

Browse files
authored
Create README.md
1 parent 9e48274 commit b660e8d

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Automata Simulation
2+
3+
## Installation
4+
5+
```
6+
git clone https://github.com/byandrev/automata-simulation
7+
```
8+
9+
10+
## Setup
11+
12+
```
13+
npm install
14+
```
15+
```
16+
npm run dev or yarn dev
17+
```
18+
19+
20+
## Contribution
21+
22+
Thank you for considering contributing to our project! We welcome contributions from the community, whether it's for fixing existing issues, adding new features, or improving the documentation. Here's how you can contribute:
23+
24+
25+
- If you find an issue or have a feature request, please first check our "Issues" section to make sure it hasn't been reported before. If it's a new issue, you can open a new issue and provide a detailed description.
26+
27+
- If you want to contribute with code, follow these steps:
28+
1. Fork this repository and clone your copy to your local machine.
29+
2. Create a new branch for your contribution: `git branch branch-name`.
30+
3. Make the necessary changes to the code.
31+
4. Ensure your changes follow our code style guidelines.
32+
5. Commit your changes: `git commit -m 'Description of the changes'`.
33+
6. Push your changes to your remote repository: `git push origin branch-name`.
34+
7. Open a pull request on our main repository, describing the changes made and providing any additional context.
35+
36+
If you have any questions or need further information, feel free to contact us via [twitter](https://www.twitter.com/byandrev).
37+
38+
## License
39+
40+
This project is licensed under the [GNU General Public License (GPL)](https://www.gnu.org/licenses/gpl-3.0.html). Please see the [LICENSE](LICENSE) file for more information on the terms and conditions of use.
41+
42+
All contributors to this project agree that their contributions will be distributed under the terms of the GPL License.

0 commit comments

Comments
 (0)