Skip to content

Commit

Permalink
upd readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
Artemchik542 committed Jul 5, 2024
1 parent 0ab6c16 commit cf1d0ee
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
16 changes: 8 additions & 8 deletions massmeta/features/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

### Каждый модуль должен строиться по след. структуре:

| Папка/Файл | Описание |
| --------------- | ------------------------------------------------- |
| **code/** | весь ваш модульный код |
| **icon/** | все ваши модульные иконки или картинки |
| **sound/** | все ваши модульный аудио файлы |
| **string/** | все ваши модульный файлы строк .txt .json |
| **includes.dm** | файл инклюдов всех ваших файлов в папке **code/** |
| **readme.md** | полная документация к модулю |
| Папка/Файл | Описание |
| ------------------ | ---------------------------------------------- |
| **code/** 📁 | Модульный код (.dm) |
| **icon/** 📁 | Модульные иконки или картинки (.dmi .png) |
| **sound/** 📁 | Модульные аудио файлы (.ogg .waw) |
| **string/** 📁 | Модульный файлы строк (.txt .json) |
| **includes.dm** 📄 | Добавление всех ваших файлов в папке **code/** |
| **readme.md** 📝 | Полная документация к модулю |

⚠️ В каждом модуле обязан быть хотя бы файл **readme.dm**! ⚠️

Expand Down
2 changes: 1 addition & 1 deletion massmeta/features/smites/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
- N/A


### Included files that are not contained in this module:
### TGUI Files:

- N/A

Expand Down
2 changes: 1 addition & 1 deletion massmeta/modular_meta.dm
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
// BEGIN_INCLUDE
#include "features\additional_circuit\includes.dm"
#include "features\hardsuits\includes.dm"
#include "features\features\kvass\includes.dm"
#include "features\kvass\includes.dm"
#include "features\smites\includes.dm"
// END_INCLUDE

Expand Down
1 change: 1 addition & 0 deletions massmeta/module_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ E.g:

### Credits:

- N/A
<!-- Here go the credits to you, dear coder, and in case of collaborative work or ports, credits to the original source of the code. -->
8 changes: 4 additions & 4 deletions massmeta/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
| Папка/Файл | Описание
| ------------------------------- | -------------------------------------------------------------|
| **~meta_defines** 📁 | Папка со всеми нашими модульно определенными defines |
| **master_files** 📁 | ? |
| **modules** 📁 | Все модульные изменения кода проекта /TG/Station |
| **tools** 📁 | Инструменты, что позволяютудобнее вести проект |
| **master_files** 📁 | Файлы, что мы модульно Переопределили у /TG/Station |
| **modules** 📁 | Все Новые модульные файлы |
| **tools** 📁 | Инструменты, что позволяют удобнее вести проект |
| **modular_meta.dm** 📄 | Файл, где описаны все наши модули, что мы добавляем в проект |
| **modular_meta_defines.dm** 📄 | Файл, где описаны все наши модульно определенные defines |
| **modularization_guide.md** 📝 | Инструкция по модульному ведению проекта (на Русском) |
| **module_template.md** 📝 | Примерный шаблон, как должен выглядеть ваше описание PR'а |
| **module_template.md** 📝 | Примерный шаблон, как должно выглядеть описание вашего PR'а |

⚠️ Все Defines, применяющиеся в вашем модуле, должны быть реализованы в папке **~meta_defines**! ⚠️

Expand Down

0 comments on commit cf1d0ee

Please sign in to comment.