stylish readme
This commit is contained in:
		
							parent
							
								
									8881505d57
								
							
						
					
					
						commit
						ce6e8ecf21
					
				
					 3 changed files with 42 additions and 9 deletions
				
			
		
							
								
								
									
										2
									
								
								Makefile
									
										
									
									
									
								
							
							
						
						
									
										2
									
								
								Makefile
									
										
									
									
									
								
							|  | @ -10,7 +10,7 @@ mpd:  ## Run mpd test instance | |||
| 	mpd --no-daemon ./mpd.conf | ||||
| 
 | ||||
| run: build  ## Run project
 | ||||
| 	./server | ||||
| 	./${PROJECT} | ||||
| 
 | ||||
| build:  ## Compile project
 | ||||
| 	go build -v -o ${PROJECT} | ||||
|  |  | |||
							
								
								
									
										47
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										47
									
								
								README.md
									
										
									
									
									
								
							|  | @ -1,21 +1,32 @@ | |||
| []() | ||||
| 
 | ||||
| # sanic | ||||
| # 🦔 sanic | ||||
| 
 | ||||
| chaos music control inspired by [relaxx player][relaxx] | ||||
| 
 | ||||
| 
 | ||||
| ## features | ||||
| ## ✨ Features | ||||
| 
 | ||||
| - mpd web gui | ||||
|   - search music | ||||
|   - organize playlists | ||||
|   - control current playback queue | ||||
| - no authentication required to control music playback | ||||
| - add music from other sources like youtube (`youtube-dl`) | ||||
| - add playlists from internet radios (`*.m3u`, `*.pls`) | ||||
| - add music from other sources like youtube (`youtube-dl`) | ||||
| 
 | ||||
| ## development | ||||
| ## 🛠️ Development | ||||
| 
 | ||||
| sanic is developed using [Nix][nix], but you can also just use the usual Golang tooling. | ||||
| 
 | ||||
| Run local [MPD][mpd] instance for testing with `make mpd`. | ||||
| 
 | ||||
| ### ❄️ w/ Nix | ||||
| 
 | ||||
| Enter development shell (also has [mpc][mpc] client installed for testing): | ||||
| 
 | ||||
| ```shell | ||||
| nix develop | ||||
| ``` | ||||
| 
 | ||||
| Build nix flake: | ||||
| 
 | ||||
|  | @ -23,12 +34,34 @@ Build nix flake: | |||
| nix build | ||||
| ``` | ||||
| 
 | ||||
| ## architecture | ||||
| ### 🐧 w/o Nix | ||||
| 
 | ||||
| Use these Make targets for convenience: | ||||
| 
 | ||||
| - `run`: Run project | ||||
| - `build`: Compile project | ||||
| - `tidy`: Add missing and remove unused modules | ||||
| - `verify`: Verify dependencies have expected content | ||||
| - `test`: Run tests | ||||
| - `cert`: Create https certificate for local testing | ||||
| 
 | ||||
| ### 🐳 Container | ||||
| 
 | ||||
| You can run sanic in a container. Use these Make targets for convenience: | ||||
| 
 | ||||
| - `build-container`: Build container image | ||||
| - `run-container`: Run container image | ||||
| 
 | ||||
| ## 🗺️ Architecture | ||||
| 
 | ||||
| [](https://app.diagrams.net/?mode=git.berlin.ccc.de#Hcccb%2Fsanic%2Fmain%2Farchitecture.drawio.svg) | ||||
| 
 | ||||
| --- | ||||
| 
 | ||||
| Made with ❤️ and 🐍. | ||||
| Made with ❤️ and ![golang logo][golang]. | ||||
| 
 | ||||
| [relaxx]: http://relaxx.dirk-hoeschen.de/ | ||||
| [nix]: https://nixos.org/manual/nix/stable/ | ||||
| [golang]: https://go.dev/images/favicon-gopher.svg | ||||
| [mpd]: https://musicpd.org/ | ||||
| [mpc]: https://www.musicpd.org/clients/mpc/ | ||||
|  |  | |||
|  | @ -5,7 +5,7 @@ port = 6600 | |||
| #pasword = | ||||
| 
 | ||||
| [ui] | ||||
| hostname = 0.0.0.0 | ||||
| hostname = [::1] | ||||
| port = 8080 | ||||
| tls = no | ||||
| cert = cert.pem | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue