readme updates + wiki references
This commit is contained in:
		
							parent
							
								
									630c06bb91
								
							
						
					
					
						commit
						93922288b1
					
				
							
								
								
									
										2
									
								
								cef/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								cef/readme.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,2 @@ | ||||
| # RageFW CEF | ||||
| [Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs) | ||||
							
								
								
									
										29
									
								
								cli/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										29
									
								
								cli/readme.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,29 @@ | ||||
| # RageFW CLI | ||||
| 
 | ||||
| To make you life easier while using RageFW we created a basic CLI. At the moment automation we have only works via [pnpm](https://pnpm.io/) | ||||
| 
 | ||||
| ``pnpm create rage-fw`` | ||||
| 
 | ||||
| ## TL;DR | ||||
| - ``Initialize new project`` - create new template project | ||||
| - ``Install RAGE:MP updater`` - download and update RAGE:MP server files | ||||
| 
 | ||||
| ## Options | ||||
| For now, you will see a few available options. They are described in detail below | ||||
| 
 | ||||
| - ``Initialize new project`` | ||||
| - ``Install RAGE:MP updater`` | ||||
| 
 | ||||
| ### Initialize new project | ||||
| Using this options will forward you to common project-creation menu | ||||
| - ``Enter project name``  | ||||
| 
 | ||||
| This option will specify a name for your project which is used as a folder name too. Defaults to **rage-fw** | ||||
| 
 | ||||
| - ``Select frontend`` | ||||
| 
 | ||||
| Use this selector menu to choose which frontend framework you want to use. We will do our best to expand this menu after some time. | ||||
| Defaults to **React + TypeScript (Vite)** | ||||
| 
 | ||||
| ### Install Rage:MP updater | ||||
| This option will simplify installation process of Rage:MP server files required to start your server | ||||
							
								
								
									
										2
									
								
								client/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								client/readme.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,2 @@ | ||||
| # RageFW Client | ||||
| [Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs) | ||||
| @ -9,7 +9,13 @@ RageFW is a type-safe framework for developing Rage:MP servers. Designed with de | ||||
|  - **Logging System:** Keep track of server activities and debug like a pro with our built-in, feature-rich logging system. After all, even virtual cops need evidence | ||||
| 
 | ||||
| ## Getting Started | ||||
| *soon* | ||||
| At the moment automation we have only works via [pnpm](https://pnpm.io/). To scaffold a basic project with minor settings you can use our CLI: | ||||
| 
 | ||||
| ``pnpm create rage-fw`` | ||||
| 
 | ||||
| This will give you a few options, among them, you can find ``Initialize new project``. Use that option to scaffold a new project for yourself using the preferred frontend framework | ||||
| 
 | ||||
| You can find out more about our CLI [here](https://git.entityseven.com/entityseven/rage-framework/wiki/CLI) | ||||
| 
 | ||||
| ## Contributing | ||||
| Join our community of developers and contribute to the ongoing development of RageFW. At the moment the only way to contribute is opening issues  | ||||
|  | ||||
							
								
								
									
										2
									
								
								server/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								server/readme.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,2 @@ | ||||
| # RageFW Server | ||||
| [Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs) | ||||
							
								
								
									
										2
									
								
								shared-types/readme.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										2
									
								
								shared-types/readme.md
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,2 @@ | ||||
| # RageFW Shared types | ||||
| [Read docs for details](https://git.entityseven.com/entityseven/rage-framework/wiki/Docs) | ||||
		Loading…
	
		Reference in New Issue
	
	Block a user