mirror of
				https://gitlab.com/Kwoth/nadekobot.git
				synced 2025-11-03 16:24:27 -05:00 
			
		
		
		
	Removed cmd-versions.json (?) and added some explanatory README.md's for individual projects
This commit is contained in:
		@@ -1,13 +0,0 @@
 | 
				
			|||||||
[
 | 
					 | 
				
			||||||
  "2.45.2",
 | 
					 | 
				
			||||||
  "2.45.1",
 | 
					 | 
				
			||||||
  "2.45.0",
 | 
					 | 
				
			||||||
  "2.44.4",
 | 
					 | 
				
			||||||
  "2.44.2",
 | 
					 | 
				
			||||||
  "2.44.0",
 | 
					 | 
				
			||||||
  "2.43.0",
 | 
					 | 
				
			||||||
  "2.42.0",
 | 
					 | 
				
			||||||
  "2.41.0",
 | 
					 | 
				
			||||||
  "2.40.0",
 | 
					 | 
				
			||||||
  "2.39.1"
 | 
					 | 
				
			||||||
]
 | 
					 | 
				
			||||||
							
								
								
									
										0
									
								
								src/NadekoBot.Coordinator/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								src/NadekoBot.Coordinator/README.md
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										24
									
								
								src/NadekoBot.Generators/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								src/NadekoBot.Generators/README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,24 @@
 | 
				
			|||||||
 | 
					## Generators
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Project which contains source generators required for NadekoBot project
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					---
 | 
				
			||||||
 | 
					### 1) Localized Strings Generator
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    -- Why --
 | 
				
			||||||
 | 
					    Type safe response strings access, and enforces correct usage of response strings.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    -- How it works --
 | 
				
			||||||
 | 
					    Creates a file "strs.cs" containing a class called "strs" in "NadekoBot" namespace.
 | 
				
			||||||
 | 
					    
 | 
				
			||||||
 | 
					    Loads "data/strings/responses.en-US.json" and creates a property or a function for each key in the responses json file based on whether the value has string format placeholders or not.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    - If a value has no placeholders, it creates a property in the strs class which returns an instance of a LocStr struct containing only the key and no replacement parameters
 | 
				
			||||||
 | 
					    
 | 
				
			||||||
 | 
					    - If a value has placeholders, it creates a function with the same number of arguments as the number of placeholders, and passes those arguments to the LocStr instance
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    -- How to use --
 | 
				
			||||||
 | 
					    1. Add a new key to responses.en-US.json "greet_me": "Hello, {0}"
 | 
				
			||||||
 | 
					    2. You now have access to a function strs.greet_me(obj p1)
 | 
				
			||||||
 | 
					    3. Using "GetText(strs.greet_me("Me"))" will return "Hello, Me"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
							
								
								
									
										1
									
								
								src/NadekoBot.Tests/README.md
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								src/NadekoBot.Tests/README.md
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1 @@
 | 
				
			|||||||
 | 
					Project which contains tests. Self explanatory
 | 
				
			||||||
		Reference in New Issue
	
	Block a user