diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..c311bf8 --- /dev/null +++ b/Home.md @@ -0,0 +1,41 @@ +# Rattail: Software for Retailers + +Welcome to the Rattail project. + +Rattail is a collection of [[http://en.wikipedia.org/wiki/Free_software|free]] software designed for use in retail environments, available under the [[http://www.gnu.org/licenses/gpl.html|GNU General Public License, version 3]]. + +## Demo + +There is a [[RattailDemo]] which is intended to show off various features of the software. It doesn't do much yet, but will be improved as the author has time. + +## Concept + +Here is a conceptual diagram of a "complete" Rattail system. The name "Poser" refers to a custom app built atop Rattail and Tailbone (the web app for Rattail). All systems on the right hand side of the graphic are ''external'' to Poser/Rattail, i.e. they are not "plugins" although Poser may use plugin-like logic for the sake of integrating with these systems. + +[see diagram](https://rattailproject.org/images/poser-concept.png) + +## Documentation + +Please see [[Documentation]] for a (hopefully) better starting point. (But that isn't really complete yet, so what you see below is left intact in the meantime.) + +Please understand that the documentation for Rattail is very much a work in progress. Some aspects have received more recent / thorough treatment than others, but it remains somewhat sparse... + + * [[FAQ]] + * [[Overview]] + * [[Installation]] + * [[Configuration]] + * [[Applications]] + * [[Utilities]] + * [[Recipes]] + * [[Hardware]] + * [Server Deployment](Deployment) + +**NOTE:** *Some documentation is maintained along with the various Python software packages; [[https://rattailproject.org/docs/|see here]] for that list.* + +**NOTE:** *There is still an older wiki available also; the content of which is mostly if not entirely outdated. [[http://rattail-archive.edbob.org/moin/|Proceed there at your own risk]]. (Use guest / guest for the HTTP auth credentials.)* + +## Development + +Please see the [Wutta Forge](https://forgejo.wuttaproject.org/rattail/) for source code, bug tracker, etc. + + * [Creating a new project](NewProject)