diff --git a/README.md b/README.md index 5e8c0fb7..2b0745d3 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ English | [**中文**](./README_ZH.md) # MemoryScope -# Installation +# 🚀 Installation ## (1) Docker-Compose (Recommanded) 1. Clone the project and edit the config. @@ -48,4 +48,32 @@ English | [**中文**](./README_ZH.md) 4. Launch the built image with command: ``` sudo docker run -it --rm --net=host memoryscope - ``` \ No newline at end of file + ``` + +# 💡 Contribute + +Contributions are always encouraged! + +We highly recommend install pre-commit hooks in this repo before committing pull requests. +These hooks are small house-keeping scripts executed every time you make a git commit, +which will take care of the formatting and linting automatically. +```shell +poetry install --with dev +pre-commit install +``` + + + +# 📖 Citation + +Reference to cite if you use MemoryScope in a paper: + +``` +@software{MemoryScope, +author = {}, +month = {08}, +title = {{MemoryScope}}, +url = {https://github.com/modelscope/MemoryScope}, +year = {2024} +} +``` \ No newline at end of file diff --git a/README_ZH.md b/README_ZH.md index 4ae08bf3..bdaebc95 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -12,3 +12,30 @@ - worker: 框架中的基本工作模块 + +# 💡 代码贡献 + +欢迎社区的代码贡献。 + +我们非常推荐每一个贡献者在代码提交前,安装`pre-commit`钩子工具, +能够帮助在每一次git提交的时候,进行自动化的代码格式校验。 +```shell +poetry install --with dev +pre-commit install +``` + + + +# 📖 引用 + +如果您在论文中有使用该项目,请添加以下引用: + +``` +@software{MemoryScope, +author = {}, +month = {08}, +title = {{MemoryScope}}, +url = {https://github.com/modelscope/MemoryScope}, +year = {2024} +} +``` \ No newline at end of file