From fee562d6e7f75ff4839ff98ccce0d91f28800a4d Mon Sep 17 00:00:00 2001 From: Janis Hutz Date: Sat, 30 Sep 2023 17:04:18 +0200 Subject: [PATCH] imporve readme, add more docs --- README.md | 24 ++++++++++-------------- website/src/contributing/packaging.md | 10 ++++++++++ 2 files changed, 20 insertions(+), 14 deletions(-) create mode 100644 website/src/contributing/packaging.md diff --git a/README.md b/README.md index 469c48a..325157a 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,19 @@ App Version -A fully featured, fully free and open source event management solution you can host yourself, to manage your event and sell tickets. All you need is a webserver that can run node.js! +A fully featured, free and open source event management solution you can host yourself, to manage your event and sell tickets. All you need is a webserver that can run node.js! Visit our [website](https://libreevent.janishutz.com) +## Development ongoing +libreǝvent currently is in a late beta state, with a fully functional version expected by mid-october. + +libreǝvent IS FREE SOFTWARE. IT IS PROVIDED "AS IS" AND AS SUCH COMES WITH ABSOLUTELY NO WARRANTY TO THE EXTENT PERMITTED BY APPLICABLE LAW. If anything does not work, please report it back, but do not expect it to be fixed immediately, as this software is developed by volunteers in their free time. + +# Download +You may download this project using the GitHub releases page or the direct links on the [libreevent website](https://libreevent.janishutz.com/download) as this only downloads the ready-to-distribute version, not the development version. +Alternatively, you may download the project directly from GitHub (by cloning it or downloading the code) but you'll have to compile and package the project [manually](https://libreevent.janishutz.com/docs/contributing/packaging). + # System requirements - node.js V16.0+ - npm @@ -33,12 +42,6 @@ Visit our [website](https://libreevent.janishutz.com) - any CPU from the last 10 years - Any operating system that can run node.js -# Download -You may download this project using the GitHub releases page or the direct links on the [libreevent website](https://libreevent.janishutz.com/download) as this only downloads the ready-to-distribute version, not the development version. -Alternatively, you may download the project directly from GitHub (by cloning it or downloading the code) but you'll have to compile and package the project [manually](https://libreevent.janishutz.com/docs/contributing/packaging). - -THIS IS FREE SOFTWARE. IT IS PROVIDED "AS IS" AND AS SUCH COMES WITH ABSOLUTELY NO WARRANTY TO THE EXTENT PERMITTED BY APPLICABLE LAW. If anything does not work, please report it back, but do not expect it to be fixed immediately, as this software is developed by volunteers in their free time. - # Contributing If you want to contribute to this project, please read more [here](https://libreevent.janishutz.com/docs/contributing). Until the end of October 2023, no contributions can be accepted into master. @@ -63,10 +66,3 @@ You may notice some additional folders appearing after running npm run package ``` This is to shrink the repository size. Distribution ready files can be found in the releases or on our [website](https://libreevent.janishutz.com/download). - -## This project is currently NOT ready to be used! -Development of this project is currently ongoing and no stable version is available yet. - - -## ROADMAP -The goal is to get this tool fully functioning by the End of September 2023. diff --git a/website/src/contributing/packaging.md b/website/src/contributing/packaging.md new file mode 100644 index 0000000..240404b --- /dev/null +++ b/website/src/contributing/packaging.md @@ -0,0 +1,10 @@ +# Packaging + +To be able to work on libreevent, you need to have node.js and npm installed on your computer. + +Then, to set up the development environment, run +``` +npm i +``` + +in the *src/server*, *src/webapp/main* and *src/webapp/setup* directories. This creates the *node_modules* folder in each of those directories. This is also what you need to do, if you want to upload the development version of libreevent. \ No newline at end of file