punky
/
botany
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Readme formatting

pull/1/head
Jake Funke 2017-03-15 21:35:14 +00:00
parent b8a5eeb6c2
commit e4f458afca
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -11,13 +11,13 @@ Check in and water your plant every 24h to keep it growing. 5 days without water
## getting started ## getting started
botany is designed for unix-based systems. Clone into a local directory using `git clone https://github.com/jifunks/botany.git`. Run with `python botany.py`. Water your seed to get started. You can come and go as you please and your plant continues to grow. Make sure to come back and water every 24 hours or your plant won't grow. If your plant goes 5 days without water, it will die! botany is designed for unix-based systems. Clone into a local directory using `git clone https://github.com/jifunks/botany.git`. Run with `python botany.py`. Water your seed to get started. You can come and go as you please and your plant continues to grow. Make sure to come back and water every 24 hours or your plant won't grow. If your plant goes 5 days without water, it will die!
*Note - botany.py must initially be run by the user who cloned/unzipped it *Note - botany.py must initially be run by the user who cloned/unzipped
this initalizes the shared data file permissions.* botany.py - this initalizes the shared data file permissions.*
## features ## features
* Curses-based menu system * Curses-based menu system
* Persistent aging system that allows your plant to grow even when app is closed * Persistent aging system that allows your plant to grow even when app is closed
* Community leaderboard (for shared unix servers) created in program directory `garden_file.json` * Community leaderboard (for shared unix servers) created in program directory `garden_file.json`
* Data file is created in your home (~) directory, along with a JSON file that you can use in your own apps. * Data file is created in the user's home (~) directory, along with a JSON file that can be used in other apps.
``` ```
{ {
"description":"common singing blue seed-bearing poppy", "description":"common singing blue seed-bearing poppy",
@ -30,10 +30,11 @@ this initalizes the shared data file permissions.*
} }
``` ```
###testing features ### testing features
* *Plant lifecycle is currently extremely short for testing - bear with me!* * *Plant lifecycle is currently extremely short for testing - bear with me!*
* *Plant mutation happens more frequently than it will in final version.*
###to-dos ### to-dos
* Add ASCII plant display * Add ASCII plant display
* Finish garden display ('garden' function) * Finish garden display ('garden' function)
* Allows you to water neighbor's plants * Allows you to water neighbor's plants