From f652f27c5e3e45ac0fd80d190a334028f9e34030 Mon Sep 17 00:00:00 2001 From: Dan Gowans Date: Tue, 15 Apr 2025 13:36:18 -0400 Subject: [PATCH] documentation --- README.md | 13 +++++++++++++ docs/installation.md | 5 ++--- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 724c089e..18f7d8cb 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ This is a major refactoring of the now archived originally built with multiple focuses in mind. This fork completely reworks the project to focus exculsively on cemetery management. +[**User Documentation (In the Works)**](./docs/README.md) + ## Why Sunrise CMS? ### ✔️ Cemetery Maps are NOT Required @@ -46,6 +48,7 @@ There's no cost to use it. ## About this Project +- 📘 [Documentation](./docs/README.md) - 🤗 [Code of Conduct](CODE_OF_CONDUCT.md) - 🥰 [Contributing Guidelines](CONTRIBUTING.md) - 🛡️ [Security Policy](SECURITY.md) @@ -54,3 +57,13 @@ There's no cost to use it. Although the system is quite niche, it's being released in an open source environment in hopes to pool developer resources from other municipalities looking to move away from older, legacy systems. It is being shared to start the dialog among other municipalities and present an option to those who may be looking to refresh their own cemetery systems. + +## More City Management Applications from the City of Sault Ste. Marie + +[**General Licence Manager**](https://cityssm.github.io/general-licence-manager/)
+An application built to manage the general licences issued by municipalities. + +[**Attendance Tracking**](https://cityssm.github.io/attendance-tracking/)
+Track employee absences, call outs, and more. + +💡 Discover even more on [the City of Sault Ste. Marie's GitHub page](https://cityssm.github.io/). diff --git a/docs/installation.md b/docs/installation.md index 53ad5411..c8e13bd0 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,13 +15,13 @@ which is able to run on budget hardware. _More is better_, however under stress tests, the application peaked at the following: -- 2 GB of RAM +- 512 MB of RAM - 1 GB of storage for application, dependencies, and data. ## Step 1: Install Node.js 18 or better and npm [Node.js](https://nodejs.org) is a JavaScript runtime environment. -Sunrise CMS is built to run on Node.js. +Sunrise CMS is built to run on Node.js, and is regularly tested on the currently supported LTS versions. [npm](https://www.npmjs.com/) is a package manager that contains all the prerequisites for Sunrise CMS. @@ -82,5 +82,4 @@ The included `windowsService-install.bat` script simplifies the process of keeping the application running in a Windows environment by creating a service that can start with the hosting server. - > npm link node-windows > windowsService-install