From c8cd44ef595a4eaab06129c3d5e1ecd5a1101d85 Mon Sep 17 00:00:00 2001 From: schnulller Date: Sat, 11 Jun 2022 15:04:52 +0200 Subject: [PATCH] Changed README --- HaWeb/README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/HaWeb/README.md b/HaWeb/README.md index 1ffea4a..4608a6e 100644 --- a/HaWeb/README.md +++ b/HaWeb/README.md @@ -1,11 +1,10 @@ # Building and preparation ## Prep -Install nodejs > 16.5 LTS. Install npm > 8.10.0. After that, do an `npm install` in the home directory to install the neccessary dependencies. -Nodejs is used for css scaffolding, this project uses `postcss`, with the `tailwindcss` CSS framework as a postcss plugin to only include used and neccessary classes. Also, the `postcss-import` postcss-plugin is used to allow for compartmentalization of css files and the import statement to merge those files together (be careful of the order of commands in postcss.config.js!). `autoprefixer` and `css-nano` plugins are important at least for production builds since they provide cross-browser-compatibility and minification of file size for css files. +Install nodejs > 16.5 LTS. Install npm > 8.10.0. After that, do an `npm install` in the home directory to install the necessary dependencies. Nodejs is used for css scaffolding, this project uses `postcss`, with the `tailwindcss` CSS framework as a postcss plugin to only include used classes. Also, the `postcss-import` postcss-plugin is used to allow for compartmentalization of css files and the import statement to merge those files together (be careful of the order of commands in postcss.config.js!). `autoprefixer` and `css-nano` plugins are important at least for production builds since they provide cross-browser-compatibility and minification of file size for css files. Dotnet 6.0.300 is currently used. To build the project, do a `dotnet restore` and collect the `Microsoft.FeatureManagement.AspNetCore` nuget-package which is used to enable feauture-flags in `appsettings.json`. Some routes, such -as the admin area of the project will only be mapped if certain flags are set to true. Also, this project requires two other projects `HaDocumentV6` (for reading in the file into convinient to use models) and `HaXMLReader` (for forward parsing the file in an HTML transform) to be present. They have no dependencies apart from each other and `.NET 6` and are build at build time automatically. +as the admin area of the project will only be mapped if certain flags are set to true. Also, this project requires two other projects `HaDocumentV6` (for reading in the file into convenient to use models) and `HaXMLReader` (for forward parsing elements such as letters, comments, traditions and marginals in an HTML transform) to be present. They have no dependencies (apart from each other and `.NET 6`) and are build at build time automatically. ## Building the project