mirror of
				https://github.com/yggdrasil-network/yggdrasil-android.git
				synced 2025-11-04 11:15:08 +03:00 
			
		
		
		
	Add a README with setup instructions
Put a `.keep` file in the `app/libs` folder so folks can put the `.aar` file in there without needing to make it first.
This commit is contained in:
		
							parent
							
								
									d10bb853a6
								
							
						
					
					
						commit
						5af2eef7cf
					
				
					 3 changed files with 59 additions and 0 deletions
				
			
		
							
								
								
									
										1
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
										
									
									
										vendored
									
									
								
							| 
						 | 
					@ -16,3 +16,4 @@
 | 
				
			||||||
local.properties
 | 
					local.properties
 | 
				
			||||||
/app/libs/yggdrasil.aar
 | 
					/app/libs/yggdrasil.aar
 | 
				
			||||||
/app/libs/yggdrasil-sources.jar
 | 
					/app/libs/yggdrasil-sources.jar
 | 
				
			||||||
 | 
					.idea
 | 
				
			||||||
							
								
								
									
										58
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										58
									
								
								README.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,58 @@
 | 
				
			||||||
 | 
					# Yggdrasil Android
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Reference implementation for connecting to the Yggdrasil Network from Android devices
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Build
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Download this repository and
 | 
				
			||||||
 | 
					the [Go Yggdrasil repository](https://github.com/yggdrasil-network/yggdrasil-go).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					git clone git@github.com:yggdrasil-network/yggdrasil-android.git
 | 
				
			||||||
 | 
					git clone git@github.com:yggdrasil-network/yggdrasil-go.git
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# or
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					git clone https://github.com/yggdrasil-network/yggdrasil-android.git
 | 
				
			||||||
 | 
					git clone https://github.com/yggdrasil-network/yggdrasil-go.git
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Generate the Android artifact (.aar) from the Go repository
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Build the Android artifact from the `yggdrasil-go` repo.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					# from yggdrasil-go
 | 
				
			||||||
 | 
					./contrib/mobile/build -a
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					If you check the folder, there should now be a `yggdrasil-sources.jar` and `yggdrasil.aar` there.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Move the Android artifact to the Android repository
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					From the Android repo, copy `yggdrasil.aar` into the `app/libs` folder.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					# from yggdrasil-android
 | 
				
			||||||
 | 
					cp ../yggdrasil-go/yggdrasil.aar app/libs/
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Build and install the Android app
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					With your Android device connected or emulator running, build and install the app.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					# from yggdrasil-android
 | 
				
			||||||
 | 
					./gradlew :app:installDebug
 | 
				
			||||||
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Configure
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Peer
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Add a peer from the [public peer list](https://publicpeers.neilalexander.dev/). Make sure to change
 | 
				
			||||||
 | 
					the "enable" toggle from off to on to make sure the peer(s) get picked up.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Explore
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Try out pages from the [list of services](https://yggdrasil-network.github.io/services.html).
 | 
				
			||||||
							
								
								
									
										0
									
								
								app/libs/.keep
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								app/libs/.keep
									
										
									
									
									
										Normal file
									
								
							
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue