- README.md - the main FarmData2 README.
- CODE_OF_CONDUCT.md - FarmData2's community standards.
- LICENSE.md - details of FarmData2's licensing.
- CHANGELOG.md - running log of changes to FarmData2 by version and scope.
- INSTALL.md - starting point for installing the FarmData2 Developer Environment.
- GitPod Installation - guide for installing the FarmData2 Developer Environment on Gitpod.
- Local Installation - guide for installing the FarmData2 Developer Environment on your machine with Docker.
- Native Installation - information about installing the FarmData2 Developer Environment on your machine without Docker.
- Developer Environment Setup - instructions for setting up the FarmData2 Developer Environment after installation.
- Connecting to the Developer Environment - instructions for connecting to the FarmData2 Developer Environment with a browser or a VNC client.
- Credentials - login credentials for the FarmData2 Developer Environment and its farmOS instance with example data.
- CONTRIBUTING.md - a step-by-step guide to contributing to FarmData2.
- Tour of Features - a guided tour of some FarmData2 features and their relationship to farmOS.
- Introduction to the Codebase - a high level overview of the organization of the FarmData2 codebase and the tools and technologies that are used.
- Detailed Contributor Guides:
- Documentation Guide - a guide to writing documentation.
- Components Guide - a guide to creating, documenting and testing Vue components.
- Entry Point Guide - a guide to creating, documenting and testing entry points.
- Library Guide - a guide to creating, documenting and testing library code.
- Infrastructure Guide - a guide to creating, documenting and testing infrastructure.
- Views Guide - a guide to creating custom API endpoints in farmOS using Views.
- Testing Tips - general tips for testing in FarmData2.
- FarmData2 Documentation - API documentation for the FarmData2 custom Vue components and JavaScript libraries.