Merge pull request #6 from CCNU-ACM-Official/dev

[docs] add readme.md

.gitignore

@@ -10,3 +10,4 @@ examples/tmp
 examples/zip
 .venv
 venv
+*.egg-info

README.md

@@ -0,0 +1,46 @@
+# CCNUACM DataMocker
+
+## Description
+
+This project is a data mocker for CCNUACM. It is written in Python.
+
+## Installation
+
+To install the necessary dependencies, run the following command:
+
+```bash
+pip3 install -e../ -U
+```
+
+## Usage
+
+Here is a basic example of how to use the data mocker:
+
+```python
+from ccnuacm_datamocker.data_model import *
+import ccnuacm_datamocker as dm
+
+dm.set_seed(751)
+dm.set_work_dir(".")
+dm.set_compiler("D:/mingw/bin/g++.exe")
+
+ds = DataSet(name="P751", std_path="./std/P751.cpp")
+
+ds.add(Sequence(LowercaseCharSet() + DigitCharSet(), length=10, sep=''))
+ds.add(Sequence(BinaryCharSet(), length=10, sep=' '))
+
+ds.run()
+```
+
+## Contributing
+
+Contributions are welcome. Please submit a pull request or create an issue to discuss the changes you want to make.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Contact
+
+If you have any questions, please feel free to post an issue.
+