Slight changes to formatting of run instructions.
This commit is contained in:
		
							parent
							
								
									2932a8f23f
								
							
						
					
					
						commit
						5214c43176
					
				
					 1 changed files with 23 additions and 21 deletions
				
			
		
							
								
								
									
										20
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										20
									
								
								README.md
									
									
									
									
									
								
							|  | @ -43,9 +43,9 @@ In order to prevent the accidental creation of Etiquette databases, you must use | ||||||
| <details> | <details> | ||||||
| <summary><strong>Running Etiquette CLI</strong></summary> | <summary><strong>Running Etiquette CLI</strong></summary> | ||||||
| 
 | 
 | ||||||
| - Run `python etiquette_cli.py` to launch the script. You should see a help message describing each of the commands. | Run `python etiquette_cli.py` to launch the script. You should see a help message describing each of the commands. | ||||||
| 
 | 
 | ||||||
| - Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | ||||||
| 
 | 
 | ||||||
|     Windows: |     Windows: | ||||||
|     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_cli.py |     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_cli.py | ||||||
|  | @ -53,16 +53,16 @@ In order to prevent the accidental creation of Etiquette databases, you must use | ||||||
|     Linux: |     Linux: | ||||||
|     /somewhere $ python /Git/Etiquette/frontends/etiquette_cli.py |     /somewhere $ python /Git/Etiquette/frontends/etiquette_cli.py | ||||||
| 
 | 
 | ||||||
| - In practice, I have a shortcut file on my PATH which runs this command. | It is expected that you create a shortcut file or launch script so you don't have to type the whole filepath every time. | ||||||
| 
 | 
 | ||||||
| </details> | </details> | ||||||
| 
 | 
 | ||||||
| <details> | <details> | ||||||
| <summary><strong>Running Etiquette Flask locally</strong></summary> | <summary><strong>Running Etiquette Flask locally</strong></summary> | ||||||
| 
 | 
 | ||||||
| - Run `python etiquette_flask_dev.py [port]` to launch the flask server. Port defaults to 5000 if not provided. | Run `python etiquette_flask_dev.py [port]` to launch the flask server. Port defaults to 5000 if not provided. | ||||||
| 
 | 
 | ||||||
| - Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | ||||||
| 
 | 
 | ||||||
|     Windows: |     Windows: | ||||||
|     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_flask\etiquette_flask_dev.py 5001 |     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_flask\etiquette_flask_dev.py 5001 | ||||||
|  | @ -70,7 +70,7 @@ In order to prevent the accidental creation of Etiquette databases, you must use | ||||||
|     Linux: |     Linux: | ||||||
|     /somewhere $ python /Git/Etiquette/frontends/etiquette_flask/etiquette_flask_dev.py 5001 |     /somewhere $ python /Git/Etiquette/frontends/etiquette_flask/etiquette_flask_dev.py 5001 | ||||||
| 
 | 
 | ||||||
| - In practice, I have a shortcut file on my PATH which runs this command. | It is expected that you create a shortcut file or launch script so you don't have to type the whole filepath every time. | ||||||
| 
 | 
 | ||||||
| </details> | </details> | ||||||
| 
 | 
 | ||||||
|  | @ -101,14 +101,16 @@ You already know that the frontend code imports the backend code. But now, gunic | ||||||
|     ~/cmd/python ~/cmd/gunicorn_py etiquette_flask_prod:site --bind "0.0.0.0:6667" --access-logfile "-" --access-logformat "%(h)s | %(t)s | %(r)s | %(s)s %(b)s" |     ~/cmd/python ~/cmd/gunicorn_py etiquette_flask_prod:site --bind "0.0.0.0:6667" --access-logfile "-" --access-logformat "%(h)s | %(t)s | %(r)s | %(s)s %(b)s" | ||||||
|     ``` |     ``` | ||||||
| 
 | 
 | ||||||
|  | It is expected that you create a shortcut file or launch script so you don't have to type the whole filepath every time. | ||||||
|  | 
 | ||||||
| </details> | </details> | ||||||
| 
 | 
 | ||||||
| <details> | <details> | ||||||
| <summary><strong>Running Etiquette REPL</strong></summary> | <summary><strong>Running Etiquette REPL</strong></summary> | ||||||
| 
 | 
 | ||||||
| - Run `python etiquette_repl.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`. | Run `python etiquette_repl.py` to launch the Python interpreter with the PhotoDB pre-loaded into a variable called `P`. Try things like `P.new_photo` or `P.digest_directory`. | ||||||
| 
 | 
 | ||||||
| - Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | Note: Do not `cd` into the frontends folder. Stay in the folder that contains your `_etiquette` database and specify the full path of the frontend launcher. | ||||||
| 
 | 
 | ||||||
|     Windows: |     Windows: | ||||||
|     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_repl.py |     D:\somewhere> python D:\Git\Etiquette\frontends\etiquette_repl.py | ||||||
|  | @ -116,7 +118,7 @@ You already know that the frontend code imports the backend code. But now, gunic | ||||||
|     Linux: |     Linux: | ||||||
|     /somewhere $ python /Git/Etiquette/frontends/etiquette_repl.py |     /somewhere $ python /Git/Etiquette/frontends/etiquette_repl.py | ||||||
| 
 | 
 | ||||||
| - In practice, I have a shortcut file on my PATH which runs this command. | It is expected that you create a shortcut file or launch script so you don't have to type the whole filepath every time. | ||||||
| 
 | 
 | ||||||
| </details> | </details> | ||||||
| </details> | </details> | ||||||
|  |  | ||||||
		Loading…
	
		Reference in a new issue